Webhooks

Synchronously sends a signed test request to the registered webhook URL and returns the delivery outcome (status code and round-trip time). Works on disabled webhooks so connectivity can be verified before activation.

post/api/webhooks/{webhookId}/ping

Request

Path parameters

webhookIdstring required

Webhook ID

Response

The ping was attempted; the result describes the outcome.

OR
OR

Changes

    • warning

      added the new SignedAgreementRequiredException enum value to the response property for the response status

    • info

      added the non-success response with the status