webhooks

Register an endpoint.

The signing secret is returned exactly once.

post/webhooks

Request

  • Base URL: https://api.agentisend.com
  • URL: https://api.agentisend.com/webhooks
  • Auth: HTTP bearer

Headers

Idempotency-Keystring

Makes this call safe to retry. Send the same key with the same body and the original response is replayed instead of the work happening twice. Keys are 1-256 characters and are remembered for 7 days. While the first attempt is still running, a second call with that key returns 409 idempotency_in_flight (Resend calls this concurrent_idempotent_requests); the same key with a different body returns 409 idempotency_payload_mismatch (Resend: invalid_idempotent_request). Resend-Idempotency-Key is accepted as the same header.

Resend-Idempotency-Keystring

Alias of Idempotency-Key. Idempotency-Key wins if both are sent.

Request body

urlstring uri

https URL that receives the events.

endpointstring uri

Same as url. url wins if both are sent.

svix_compatboolean

Also sign each delivery the way a Svix receiver already verifies. Off unless set.

payload_format'native' | 'resend'

native is this API’s envelope. resend is the envelope a Resend receiver already parses.

Response

Success

object'webhook' required
idstring uuid required
urlstring required
endpointstring required
eventsstring[] required
disabledboolean required
status'enabled' | 'disabled' required
svix_compatboolean required
payload_format'native' | 'resend' required
last_delivery_status'pending' | 'retrying' | 'delivered' | 'dead_lettered' nullable required
created_atstring date-time required
updated_atstring date-time required
secretstring required

Signing secret, shown once. Store it. Later calls do not return it.

signing_secretstring required

Same value as secret. The name a receiver already reads.

Changes

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