Skip to main content
POST
/
webhooks
/
{id}
/
ping
Ping webhook
curl --request POST \
  --url https://api.sandbox.iron.xyz/api/webhooks/{id}/ping \
  --header 'Content-Type: application/json; charset=utf-8' \
  --header 'IDEMPOTENCY-KEY: <idempotency-key>' \
  --header 'X-API-Key: <api-key>' \
  --header 'X-SUB-PARTNER-ID: <x-sub-partner-id>' \
  --data '
{
  "customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'
true

Authorizations

​
X-API-Key
string
header
required

API Key

Headers

​
IDEMPOTENCY-KEY
string
required

a UUID ensuring the ping operation is only processed once

​
X-SUB-PARTNER-ID
string
required

Optional sub-partner UUID, if provided, the webhook will be pinged under scope of the sub-partner

Path Parameters

​
id
string<uuid>
required

the ID of the webhook to ping

Body

application/json; charset=utf-8

Parameters required to ping a webhook

​
customer_id
string<uuid>
required

Customer ID to use for the webhook ping

Response

Successfully pinged webhook

The response is of type boolean.