CRcrowdin
Webhooks

Test Webhook

Required scopes: project.webhook (Read and Write).

Sends a sample payload of one webhook event to the saved webhook URL, with the saved request method, content type and headers, and returns the answer of the target server. A failure of the target server is returned as data with status set to failed, not as an error. Test requests are not added to the webhook deliveries. The request body can be omitted.

Note: The target system may act on the sample payload

post/projects/{projectId}/webhooks/{webhookId}/tests

Request

Path parameters

projectIdinteger required

Project Identifier. Get via List Projects

webhookIdinteger required

Webhook Identifier. Get via List Webhooks

Request body

eventstring

Event to send a sample payload for. Must be one of the webhook events. Default is the first event of the webhook

Example request

{
  "event": "file.translated"
}

Response

Test request result

Example response

{
  "data": {
    "event": "file.translated",
    "url": "https://hooks.example.com/crowdin",
    "payload": {
      "event": "file.translated",
      "project": "acme-docs",
      "language": "uk"
    },
    "status": "success",
    "responseStatusCode": 200,
    "responseBody": "ok"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.