POST/v2/agents/triggers/{trigger_id}/webhook

Receive a trigger webhook delivery

Receives a signed webhook delivery from an external system for a trigger. The caller is the external system, and each delivery is authenticated with the trigger's provider-specific signature or token. Successful deliveries are accepted for asynchronous processing; paused triggers and deduplicated retries also receive an accepted response.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

1 parameter
trigger_idstringrequired
The UUID of the trigger receiving the webhook delivery.

7 status codes
202Returns an `execution_id` for the queued delivery, including a deduplicated retry; a paused trigger returns an empty body and queues no execution.
execution_idstringoptional
The queued (or deduped-existing) execution. Absent when the trigger is paused (202 with empty body).
400Returned when the request body is too large or unreadable.
idstringrequired
A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be "not_found."
messagestringrequired
A message providing additional information about the error, including details to help resolve it when possible.
request_idstringoptional
Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.
401Returned when the provider signature or token cannot be verified.
idstringrequired
A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be "not_found."
messagestringrequired
A message providing additional information about the error, including details to help resolve it when possible.
request_idstringoptional
Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.
404Returned when the trigger resource is not found.
idstringrequired
A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be "not_found."
messagestringrequired
A message providing additional information about the error, including details to help resolve it when possible.
request_idstringoptional
Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.
429Returned when the API rate limit has been exceeded.
idstringrequired
A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be "not_found."
messagestringrequired
A message providing additional information about the error, including details to help resolve it when possible.
request_idstringoptional
Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.
500Returned when a server error occurs.
idstringrequired
A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be "not_found."
messagestringrequired
A message providing additional information about the error, including details to help resolve it when possible.
request_idstringoptional
Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.
defaultThere was an unexpected error.
idstringrequired
A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be "not_found."
messagestringrequired
A message providing additional information about the error, including details to help resolve it when possible.
request_idstringoptional
Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.

Error handling

A 400 is returned when the raw request body is too large or unreadable; a 401 indicates that provider signature or token verification failed; a 404 indicates that the resource was not found; a 429 indicates that the API rate limit was exceeded; and a 500 indicates a server error. Send the provider's signature header and preserve the exact raw body bytes: GitHub uses X-Hub-Signature-256, GitLab uses X-Gitlab-Token, and custom providers use X-DigitalOcean-Signature (or the transitional do-signature alias). The trigger_id path parameter must identify an existing trigger.