Webhooks

Ping a subscription

Ping a subscription to get a realistic notification in the configured URL. This does not require a request body and does not return one: it generates a ping event to simulate the workflow of a regular webhook, triggering a notification for the subscription's configured URL with the X-Ebury-Webhook header set to Ping.

post/webhooks/ping/{subscription_id}

Request

  • Base URL: https://api.ebury.io
  • URL: https://api.ebury.io/webhooks/ping/{subscription_id}
  • Auth: API key in header x-api-key

Path parameters

subscription_idstring required

The UUID of the subscription

Query parameters

client_idstring

The identifier of a client. Required unless the X-Client-ID header is provided instead.

Headers

X-Client-IDstring

The identifier of a client. Alternative to the client_id query parameter. Required unless client_id is provided instead.

Authorizationstring required

The access token.

Response

Ping was successful

Changes

No recorded changes to this operation across all 1 revision of this API.