Create webhook
Create a webhook endpoint. The signing secret is returned only once.
Headers
Unique key for safely retrying a request without creating duplicates.
Caller-chosen identifier for the agent run, session, or conversation, required when an agent moves money.
Request body
Response
Successful Response
Changes
Changed in 14 of the 50 revisions of this API.55270
- ●
added the new
check.canceledenum value to the///response property for the response statusresponse-property-enum-value-added
- ●
added the new
check.completedenum value to the///response property for the response statusresponse-property-enum-value-added
- ●
added the new
check.createdenum value to the///response property for the response statusresponse-property-enum-value-added
- ●
added the new
check.expiredenum value to the///response property for the response statusresponse-property-enum-value-added
- ●
added the new
check.failedenum value to the///response property for the response statusresponse-property-enum-value-added
- ●
added the new
check.processingenum value to the///response property for the response statusresponse-property-enum-value-added
- ●
added the new
check.rejectedenum value to the///response property for the response statusresponse-property-enum-value-added
- ●
added the new
check.returnedenum value to the///response property for the response statusresponse-property-enum-value-added
- ●
added the new
check.returned_to_senderenum value to the///response property for the response statusresponse-property-enum-value-added
- ○
added the new
check.canceledenum value to the request property///request-property-enum-value-added
- ○
added the new
check.completedenum value to the request property///request-property-enum-value-added
- ○
added the new
check.createdenum value to the request property///request-property-enum-value-added
- ○
added the new
check.expiredenum value to the request property///request-property-enum-value-added
- ○
added the new
check.failedenum value to the request property///request-property-enum-value-added
- ○
added the new
check.processingenum value to the request property///request-property-enum-value-added
- ○
added the new
check.rejectedenum value to the request property///request-property-enum-value-added
- ○
added the new
check.returnedenum value to the request property///request-property-enum-value-added
- ○
added the new
check.returned_to_senderenum value to the request property///request-property-enum-value-added
- ●
- ●
added the new
cardPayment.createdenum value to the///response property for the response statusresponse-property-enum-value-added
- ●
added the new
cardPayment.failedenum value to the///response property for the response statusresponse-property-enum-value-added
- ●
added the new
cardPayment.succeededenum value to the///response property for the response statusresponse-property-enum-value-added
- ●
added the new
chargeback.closedenum value to the///response property for the response statusresponse-property-enum-value-added
- ●
added the new
chargeback.createdenum value to the///response property for the response statusresponse-property-enum-value-added
- ●
added the new
chargeback.updatedenum value to the///response property for the response statusresponse-property-enum-value-added
- ●
added the new
enrollment.activatedenum value to the///response property for the response statusresponse-property-enum-value-added
- ●
added the new
enrollment.appliedenum value to the///response property for the response statusresponse-property-enum-value-added
- ●
added the new
enrollment.offboardedenum value to the///response property for the response statusresponse-property-enum-value-added
- ●
added the new
enrollment.rejectedenum value to the///response property for the response statusresponse-property-enum-value-added
- ●
added the new
mandate.createdenum value to the///response property for the response statusresponse-property-enum-value-added
- ●
added the new
mandate.revokedenum value to the///response property for the response statusresponse-property-enum-value-added
- ●
added the new
mandate.updatedenum value to the///response property for the response statusresponse-property-enum-value-added
- ●
added the new
paymentIntent.canceledenum value to the///response property for the response statusresponse-property-enum-value-added
- ●
added the new
paymentIntent.completedenum value to the///response property for the response statusresponse-property-enum-value-added
- ●
added the new
refund.createdenum value to the///response property for the response statusresponse-property-enum-value-added
- ●
added the new
refund.failedenum value to the///response property for the response statusresponse-property-enum-value-added
- ●
added the new
refund.succeededenum value to the///response property for the response statusresponse-property-enum-value-added
- ○
added the new
cardPayment.createdenum value to the request property///request-property-enum-value-added
- ○
added the new
cardPayment.failedenum value to the request property///request-property-enum-value-added
- ○
added the new
cardPayment.succeededenum value to the request property///request-property-enum-value-added
- ○
added the new
chargeback.closedenum value to the request property///request-property-enum-value-added
- ○
added the new
chargeback.createdenum value to the request property///request-property-enum-value-added
- ○
added the new
chargeback.updatedenum value to the request property///request-property-enum-value-added
- ○
added the new
enrollment.activatedenum value to the request property///request-property-enum-value-added
- ○
added the new
enrollment.appliedenum value to the request property///request-property-enum-value-added
- ○
added the new
enrollment.offboardedenum value to the request property///request-property-enum-value-added
- ○
added the new
enrollment.rejectedenum value to the request property///request-property-enum-value-added
- ○
added the new
mandate.createdenum value to the request property///request-property-enum-value-added
- ○
added the new
mandate.revokedenum value to the request property///request-property-enum-value-added
- ○
added the new
mandate.updatedenum value to the request property///request-property-enum-value-added
- ○
added the new
paymentIntent.canceledenum value to the request property///request-property-enum-value-added
- ○
added the new
paymentIntent.completedenum value to the request property///request-property-enum-value-added
- ○
added the new
refund.createdenum value to the request property///request-property-enum-value-added
- ○
added the new
refund.failedenum value to the request property///request-property-enum-value-added
- ○
added the new
refund.succeededenum value to the request property///request-property-enum-value-added
- ●
- ●
added the new
wire.completedenum value to the///response property for the response statusresponse-property-enum-value-added
- ●
added the new
wire.createdenum value to the///response property for the response statusresponse-property-enum-value-added
- ●
added the new
wire.failedenum value to the///response property for the response statusresponse-property-enum-value-added
- ●
added the new
wire.processingenum value to the///response property for the response statusresponse-property-enum-value-added
- ●
added the new
wire.rejectedenum value to the///response property for the response statusresponse-property-enum-value-added
- ○
added the new
wire.completedenum value to the request property///request-property-enum-value-added
- ○
added the new
wire.createdenum value to the request property///request-property-enum-value-added
- ○
added the new
wire.failedenum value to the request property///request-property-enum-value-added
- ○
added the new
wire.processingenum value to the request property///request-property-enum-value-added
- ○
added the new
wire.rejectedenum value to the request property///request-property-enum-value-added
- ●
- ●
added the new
realtime.createdenum value to the///response property for the response statusresponse-property-enum-value-added
- ●
added the new
realtime.failedenum value to the///response property for the response statusresponse-property-enum-value-added
- ●
added the new
realtime.processingenum value to the///response property for the response statusresponse-property-enum-value-added
- ●
added the new
realtime.settledenum value to the///response property for the response statusresponse-property-enum-value-added
- ○
added the new
realtime.createdenum value to the request property///request-property-enum-value-added
- ○
added the new
realtime.failedenum value to the request property///request-property-enum-value-added
- ○
added the new
realtime.processingenum value to the request property///request-property-enum-value-added
- ○
added the new
realtime.settledenum value to the request property///request-property-enum-value-added
- ●
- ○
added the new optional request property
//new-optional-request-property
- ○
added the required property
//to the response with the statusresponse-required-property-added
- ○
- ○
added the optional property
///to the response with the statusresponse-optional-property-added
- ○
added the optional property
///to the response with the statusresponse-optional-property-added
- ○
added the optional property
///to the response with the statusresponse-optional-property-added
- ○
added the optional property
///to the response with the statusresponse-optional-property-added
- ○
added the optional property
///to the response with the statusresponse-optional-property-added
- ○
added the optional property
///to the response with the statusresponse-optional-property-added
- ○
added the optional property
///to the response with the statusresponse-optional-property-added
- ○
added the optional property
///to the response with the statusresponse-optional-property-added
- ○
added the optional property
///to the response with the statusresponse-optional-property-added
- ○
added the optional property
///to the response with the statusresponse-optional-property-added
- ○
added the optional property
///to the response with the statusresponse-optional-property-added
- ○
added the optional property
///to the response with the statusresponse-optional-property-added
- ○
- ○
deleted the
headerrequest parameterX-Agent-IDwith deprecationrequest-parameter-removed-with-deprecation
- ○
- ○
headerrequest parameterX-Agent-IDwas deprecatedrequest-parameter-deprecated
- ○
- ▲
removed the enum value
mandate.createdof the request property///request-property-enum-value-removed
- ▲
removed the enum value
mandate.revokedof the request property///request-property-enum-value-removed
- ○
removed the
mandate.createdenum value from the///response property for the response statusresponse-property-enum-value-removed
- ○
removed the
mandate.revokedenum value from the///response property for the response statusresponse-property-enum-value-removed
- ▲
- ▲
removed the enum value
ach.completedof the request property///request-property-enum-value-removed
- ●
added the new
ach.settledenum value to the///response property for the response statusresponse-property-enum-value-added
- ○
added the new
ach.settledenum value to the request property///request-property-enum-value-added
- ○
removed the
ach.completedenum value from the///response property for the response statusresponse-property-enum-value-removed
- ▲