Webhooks

Get webhook

Get a webhook endpoint

get/webhooks/{webhookId}

Path parameters

webhookIdstring required

Webhook ID (whk_*).

Headers

X-Instance-IDstring nullable

Caller-chosen identifier for the agent run, session, or conversation, required when an agent moves money.

Response

Successful Response

Changes

Changed in 8 of the 28 revisions of this API.1155

Aug 27, 2026359d267dca881See the full diff
- ○
  deleted the header request parameter X-Agent-ID with deprecation
  request-parameter-removed-with-deprecation
Aug 23, 2026b1ad79e918ac1See the full diff
- ○
  header request parameter X-Agent-ID was deprecated
  request-parameter-deprecated
Aug 19, 2026c2c65e0527112See the full diff
- ○
  removed the mandate.created enum value from the data/attributes/enabledEvents/items/ response property for the response status 200
  response-property-enum-value-removed
- ○
  removed the mandate.revoked enum value from the data/attributes/enabledEvents/items/ response property for the response status 200
  response-property-enum-value-removed
Aug 19, 2026a77f94c2883a11See the full diff
- ●
  added the new ach.settled enum value to the data/attributes/enabledEvents/items/ response property for the response status 200
  response-property-enum-value-added
- ○
  removed the ach.completed enum value from the data/attributes/enabledEvents/items/ response property for the response status 200
  response-property-enum-value-removed
Aug 15, 2026c309952835b58See the full diff
- ●
  added the new ach.completed enum value to the data/attributes/enabledEvents/items/ response property for the response status 200
  response-property-enum-value-added
- ●
  added the new ach.created enum value to the data/attributes/enabledEvents/items/ response property for the response status 200
  response-property-enum-value-added
- ●
  added the new ach.failed enum value to the data/attributes/enabledEvents/items/ response property for the response status 200
  response-property-enum-value-added
- ●
  added the new ach.processing enum value to the data/attributes/enabledEvents/items/ response property for the response status 200
  response-property-enum-value-added
- ●
  added the new ach.returned enum value to the data/attributes/enabledEvents/items/ response property for the response status 200
  response-property-enum-value-added
- ●
  added the new external_party_account.validated enum value to the data/attributes/enabledEvents/items/ response property for the response status 200
  response-property-enum-value-added
- ●
  added the new mandate.created enum value to the data/attributes/enabledEvents/items/ response property for the response status 200
  response-property-enum-value-added
- ●
  added the new mandate.revoked enum value to the data/attributes/enabledEvents/items/ response property for the response status 200
  response-property-enum-value-added
Aug 8, 20260bb9c54b1f611See the full diff
- ▲
  added the pattern ^whk_[0-9a-f]{32}$ to the path request parameter webhookId
  request-parameter-pattern-added
Aug 4, 202668aaf2076cfc5See the full diff
- ●
  added the new invitation_link.agent_added enum value to the data/attributes/enabledEvents/items/ response property for the response status 200
  response-property-enum-value-added
- ●
  added the new invitation_link.agent_removed enum value to the data/attributes/enabledEvents/items/ response property for the response status 200
  response-property-enum-value-added
- ●
  added the new invitation_link.created enum value to the data/attributes/enabledEvents/items/ response property for the response status 200
  response-property-enum-value-added
- ●
  added the new invitation_link.redeemed enum value to the data/attributes/enabledEvents/items/ response property for the response status 200
  response-property-enum-value-added
- ●
  added the new invitation_link.revoked enum value to the data/attributes/enabledEvents/items/ response property for the response status 200
  response-property-enum-value-added
Jul 26, 2026270e233e401c1See the full diff
- ●
  for the path request parameter webhookId, the maxLength was set to 64
  request-parameter-max-length-set

Full history