Webhooks

Create webhook

Create a webhook endpoint. The signing secret is returned only once.

post/webhooks

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 14 of the 50 revisions of this API.55270

  • 6e52d1bd005499See the full diff
    • ●

      added the new check.canceled enum value to the /// response property for the response status

      response-property-enum-value-added

    • ●

      added the new check.completed enum value to the /// response property for the response status

      response-property-enum-value-added

    • ●

      added the new check.created enum value to the /// response property for the response status

      response-property-enum-value-added

    • ●

      added the new check.expired enum value to the /// response property for the response status

      response-property-enum-value-added

    • ●

      added the new check.failed enum value to the /// response property for the response status

      response-property-enum-value-added

    • ●

      added the new check.processing enum value to the /// response property for the response status

      response-property-enum-value-added

    • ●

      added the new check.rejected enum value to the /// response property for the response status

      response-property-enum-value-added

    • ●

      added the new check.returned enum value to the /// response property for the response status

      response-property-enum-value-added

    • ●

      added the new check.returned_to_sender enum value to the /// response property for the response status

      response-property-enum-value-added

    • ○

      added the new check.canceled enum value to the request property ///

      request-property-enum-value-added

    • ○

      added the new check.completed enum value to the request property ///

      request-property-enum-value-added

    • ○

      added the new check.created enum value to the request property ///

      request-property-enum-value-added

    • ○

      added the new check.expired enum value to the request property ///

      request-property-enum-value-added

    • ○

      added the new check.failed enum value to the request property ///

      request-property-enum-value-added

    • ○

      added the new check.processing enum value to the request property ///

      request-property-enum-value-added

    • ○

      added the new check.rejected enum value to the request property ///

      request-property-enum-value-added

    • ○

      added the new check.returned enum value to the request property ///

      request-property-enum-value-added

    • ○

      added the new check.returned_to_sender enum value to the request property ///

      request-property-enum-value-added

  • 1132c9ddb7bd1818See the full diff
    • ●

      added the new cardPayment.created enum value to the /// response property for the response status

      response-property-enum-value-added

    • ●

      added the new cardPayment.failed enum value to the /// response property for the response status

      response-property-enum-value-added

    • ●

      added the new cardPayment.succeeded enum value to the /// response property for the response status

      response-property-enum-value-added

    • ●

      added the new chargeback.closed enum value to the /// response property for the response status

      response-property-enum-value-added

    • ●

      added the new chargeback.created enum value to the /// response property for the response status

      response-property-enum-value-added

    • ●

      added the new chargeback.updated enum value to the /// response property for the response status

      response-property-enum-value-added

    • ●

      added the new enrollment.activated enum value to the /// response property for the response status

      response-property-enum-value-added

    • ●

      added the new enrollment.applied enum value to the /// response property for the response status

      response-property-enum-value-added

    • ●

      added the new enrollment.offboarded enum value to the /// response property for the response status

      response-property-enum-value-added

    • ●

      added the new enrollment.rejected enum value to the /// response property for the response status

      response-property-enum-value-added

    • ●

      added the new mandate.created enum value to the /// response property for the response status

      response-property-enum-value-added

    • ●

      added the new mandate.revoked enum value to the /// response property for the response status

      response-property-enum-value-added

    • ●

      added the new mandate.updated enum value to the /// response property for the response status

      response-property-enum-value-added

    • ●

      added the new paymentIntent.canceled enum value to the /// response property for the response status

      response-property-enum-value-added

    • ●

      added the new paymentIntent.completed enum value to the /// response property for the response status

      response-property-enum-value-added

    • ●

      added the new refund.created enum value to the /// response property for the response status

      response-property-enum-value-added

    • ●

      added the new refund.failed enum value to the /// response property for the response status

      response-property-enum-value-added

    • ●

      added the new refund.succeeded enum value to the /// response property for the response status

      response-property-enum-value-added

    • ○

      added the new cardPayment.created enum value to the request property ///

      request-property-enum-value-added

    • ○

      added the new cardPayment.failed enum value to the request property ///

      request-property-enum-value-added

    • ○

      added the new cardPayment.succeeded enum value to the request property ///

      request-property-enum-value-added

    • ○

      added the new chargeback.closed enum value to the request property ///

      request-property-enum-value-added

    • ○

      added the new chargeback.created enum value to the request property ///

      request-property-enum-value-added

    • ○

      added the new chargeback.updated enum value to the request property ///

      request-property-enum-value-added

    • ○

      added the new enrollment.activated enum value to the request property ///

      request-property-enum-value-added

    • ○

      added the new enrollment.applied enum value to the request property ///

      request-property-enum-value-added

    • ○

      added the new enrollment.offboarded enum value to the request property ///

      request-property-enum-value-added

    • ○

      added the new enrollment.rejected enum value to the request property ///

      request-property-enum-value-added

    • ○

      added the new mandate.created enum value to the request property ///

      request-property-enum-value-added

    • ○

      added the new mandate.revoked enum value to the request property ///

      request-property-enum-value-added

    • ○

      added the new mandate.updated enum value to the request property ///

      request-property-enum-value-added

    • ○

      added the new paymentIntent.canceled enum value to the request property ///

      request-property-enum-value-added

    • ○

      added the new paymentIntent.completed enum value to the request property ///

      request-property-enum-value-added

    • ○

      added the new refund.created enum value to the request property ///

      request-property-enum-value-added

    • ○

      added the new refund.failed enum value to the request property ///

      request-property-enum-value-added

    • ○

      added the new refund.succeeded enum value to the request property ///

      request-property-enum-value-added

  • 226131258c1255See the full diff
    • ●

      added the new wire.completed enum value to the /// response property for the response status

      response-property-enum-value-added

    • ●

      added the new wire.created enum value to the /// response property for the response status

      response-property-enum-value-added

    • ●

      added the new wire.failed enum value to the /// response property for the response status

      response-property-enum-value-added

    • ●

      added the new wire.processing enum value to the /// response property for the response status

      response-property-enum-value-added

    • ●

      added the new wire.rejected enum value to the /// response property for the response status

      response-property-enum-value-added

    • ○

      added the new wire.completed enum value to the request property ///

      request-property-enum-value-added

    • ○

      added the new wire.created enum value to the request property ///

      request-property-enum-value-added

    • ○

      added the new wire.failed enum value to the request property ///

      request-property-enum-value-added

    • ○

      added the new wire.processing enum value to the request property ///

      request-property-enum-value-added

    • ○

      added the new wire.rejected enum value to the request property ///

      request-property-enum-value-added

    • ●

      added the new realtime.created enum value to the /// response property for the response status

      response-property-enum-value-added

    • ●

      added the new realtime.failed enum value to the /// response property for the response status

      response-property-enum-value-added

    • ●

      added the new realtime.processing enum value to the /// response property for the response status

      response-property-enum-value-added

    • ●

      added the new realtime.settled enum value to the /// response property for the response status

      response-property-enum-value-added

    • ○

      added the new realtime.created enum value to the request property ///

      request-property-enum-value-added

    • ○

      added the new realtime.failed enum value to the request property ///

      request-property-enum-value-added

    • ○

      added the new realtime.processing enum value to the request property ///

      request-property-enum-value-added

    • ○

      added the new realtime.settled enum 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 status

      response-required-property-added

    • ○

      added the optional property /// to the response with the status

      response-optional-property-added

    • ○

      added the optional property /// to the response with the status

      response-optional-property-added

    • ○

      added the optional property /// to the response with the status

      response-optional-property-added

    • ○

      added the optional property /// to the response with the status

      response-optional-property-added

    • ○

      added the optional property /// to the response with the status

      response-optional-property-added

    • ○

      added the optional property /// to the response with the status

      response-optional-property-added

    • ○

      added the optional property /// to the response with the status

      response-optional-property-added

    • ○

      added the optional property /// to the response with the status

      response-optional-property-added

    • ○

      added the optional property /// to the response with the status

      response-optional-property-added

    • ○

      added the optional property /// to the response with the status

      response-optional-property-added

    • ○

      added the optional property /// to the response with the status

      response-optional-property-added

    • ○

      added the optional property /// to the response with the status

      response-optional-property-added

    • ○

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

      request-parameter-removed-with-deprecation

    • ○

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

      request-property-enum-value-removed

    • ▲

      removed the enum value mandate.revoked of the request property ///

      request-property-enum-value-removed

    • ○

      removed the mandate.created enum value from the /// response property for the response status

      response-property-enum-value-removed

    • ○

      removed the mandate.revoked enum value from the /// response property for the response status

      response-property-enum-value-removed

  • a77f94c2883a112See the full diff
    • ▲

      removed the enum value ach.completed of the request property ///

      request-property-enum-value-removed

    • ●

      added the new ach.settled enum value to the /// response property for the response status

      response-property-enum-value-added

    • ○

      added the new ach.settled enum value to the request property ///

      request-property-enum-value-added

    • ○

      removed the ach.completed enum value from the /// response property for the response status

      response-property-enum-value-removed