Sign in
Webhooks

Update webhook

Update a webhook endpoint

patch/webhooks/{webhookId}

Path parameters

webhookIdstring required

Webhook ID (whk_*).

Headers

Idempotency-Keystring required

Unique key for safely retrying a request without creating duplicates.

X-Instance-IDstring nullable

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

Request body

Response

Successful Response

Changes

Changed in 9 of the 28 revisions of this API.51720

  • 359d267dca881See the full diff
    • ○

      deleted the header request parameter X-Agent-ID with deprecation

      request-parameter-removed-with-deprecation

  • b1ad79e918ac1See the full diff
    • ○

      header request parameter X-Agent-ID was deprecated

      request-parameter-deprecated

  • c2c65e05271122See the full diff
    • ▲

      removed the enum value mandate.created of the request property data/attributes/enabledEvents/items/

      request-property-enum-value-removed

    • ▲

      removed the enum value mandate.revoked of the request property data/attributes/enabledEvents/items/

      request-property-enum-value-removed

    • ○

      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

  • a77f94c2883a112See the full diff
    • ▲

      removed the enum value ach.completed of the request property data/attributes/enabledEvents/items/

      request-property-enum-value-removed

    • ●

      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

    • ○

      added the new ach.settled enum value to the request property data/attributes/enabledEvents/items/

      request-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

  • c309952835b588See 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

    • ○

      added the new ach.completed enum value to the request property data/attributes/enabledEvents/items/

      request-property-enum-value-added

    • ○

      added the new ach.created enum value to the request property data/attributes/enabledEvents/items/

      request-property-enum-value-added

    • ○

      added the new ach.failed enum value to the request property data/attributes/enabledEvents/items/

      request-property-enum-value-added

    • ○

      added the new ach.processing enum value to the request property data/attributes/enabledEvents/items/

      request-property-enum-value-added

    • ○

      added the new ach.returned enum value to the request property data/attributes/enabledEvents/items/

      request-property-enum-value-added

    • ○

      added the new external_party_account.validated enum value to the request property data/attributes/enabledEvents/items/

      request-property-enum-value-added

    • ○

      added the new mandate.created enum value to the request property data/attributes/enabledEvents/items/

      request-property-enum-value-added

    • ○

      added the new mandate.revoked enum value to the request property data/attributes/enabledEvents/items/

      request-property-enum-value-added

  • 0bb9c54b1f611See the full diff
    • ▲

      added the pattern ^whk_[0-9a-f]{32}$ to the path request parameter webhookId

      request-parameter-pattern-added

  • 68aaf2076cfc55See 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

    • ○

      added the new invitation_link.agent_added enum value to the request property data/attributes/enabledEvents/items/

      request-property-enum-value-added

    • ○

      added the new invitation_link.agent_removed enum value to the request property data/attributes/enabledEvents/items/

      request-property-enum-value-added

    • ○

      added the new invitation_link.created enum value to the request property data/attributes/enabledEvents/items/

      request-property-enum-value-added

    • ○

      added the new invitation_link.redeemed enum value to the request property data/attributes/enabledEvents/items/

      request-property-enum-value-added

    • ○

      added the new invitation_link.revoked enum value to the request property data/attributes/enabledEvents/items/

      request-property-enum-value-added

  • 270e233e401c13See the full diff
    • ▲

      the data/attributes/description request property's maxLength was decreased to 100

      request-property-max-length-decreased

    • ●

      for the header request parameter Idempotency-Key, the maxLength was set to 255

      request-parameter-max-length-set

    • ●

      for the path request parameter webhookId, the maxLength was set to 64

      request-parameter-max-length-set

    • ●

      the data/attributes/url request property's maxLength was set to 2048

      request-property-max-length-set

  • 8cc2aed458471See the full diff
    • ○

      endpoint added

      endpoint-added