Send an event to a webhook
Choose a destination to receive the original event, even without a previous delivery.
Provide the event in the path and the webhook in the body. The destination must be active, select the event type and belong to the same authenticated company and environment. The request allows the first delivery of the event to this webhook.
The event must be no more than 15 days old and its original body must still
be available. The response returns the delivery_id for tracking;
acceptance of the request does not confirm receipt by the receiver. If the
queue is paused, the delivery waits for it to resume within its own deadline.
See Send to a webhook to check the limits, preserve the event identity and handle duplicates.
Path Params
Identifier of the original event to send to the chosen webhook.
Headers
Unique key chosen by your system to identify this request. When retrying, send the same key and parameters. Without this header, the request is processed normally. See the idempotency guide for retention and handling pending or uncertain responses.
1 to 255 characters
Body Params
Applying an example replaces the body fields.
Identifier of the active webhook that selects the event type. Use a webhook from the same company and environment as the key.
Up to 26 characters
Responses
Response Body
Request accepted. Query the new delivery to track its result.
Resend request accepted.
Identifier of the new delivery. Use it to track the resend.
Original identifier preserved in the sent content.
Response Body
A field is missing or has an invalid format. Check the details before resubmitting.
Code and explanation of the error returned by the API.
Stable error code.
Error explanation in English. For validation errors, it summarizes the category; details identify the corrections. Use the codes to handle the response.
Invalid fields or references submitted in the body, with the field, code and explanation. Omitted for general errors and when there is no field correction to indicate.
Public name of the JSON field, query parameter, path parameter or header related to the error. Nested fields and lists retain their path and index. $ represents the root of the JSON body.
Reason for the field error, such as REQUIRED, INVALID_TAXID, UNKNOWN_FIELD, DUPLICATE_FIELD or INVALID_TYPE.
Explanation in English of the problem with this field or parameter and the available correction. Do not use the text to determine your integration flow.
Response Body
The specified event or webhook was not found within the key's scope.
Code and explanation of the error returned by the API.
Stable error code.
Error explanation in English. For validation errors, it summarizes the category; details identify the corrections. Use the codes to handle the response.
Invalid fields or references submitted in the body, with the field, code and explanation. Omitted for general errors and when there is no field correction to indicate.
Public name of the JSON field, query parameter, path parameter or header related to the error. Nested fields and lists retain their path and index. $ represents the root of the JSON body.
Reason for the field error, such as REQUIRED, INVALID_TAXID, UNKNOWN_FIELD, DUPLICATE_FIELD or INVALID_TYPE.
Explanation in English of the problem with this field or parameter and the available correction. Do not use the text to determine your integration flow.
Response Body
The event has passed its deadline, its body is unavailable, the destination does not allow sending or the event is a test event. Check the returned condition before making another request.
Code and explanation of the error returned by the API.
Stable error code.
Error explanation in English. For validation errors, it summarizes the category; details identify the corrections. Use the codes to handle the response.
Invalid fields or references submitted in the body, with the field, code and explanation. Omitted for general errors and when there is no field correction to indicate.
Public name of the JSON field, query parameter, path parameter or header related to the error. Nested fields and lists retain their path and index. $ represents the root of the JSON body.
Reason for the field error, such as REQUIRED, INVALID_TAXID, UNKNOWN_FIELD, DUPLICATE_FIELD or INVALID_TYPE.
Explanation in English of the problem with this field or parameter and the available correction. Do not use the text to determine your integration flow.
For common errors, see HTTP response codes.