Send a test ping to the webhook

Queues one signed ping event (see webhooks, ping) to the partner’s webhook URL, delivered the way every event is: a POST of the event as JSON, signed in the Standard Webhooks scheme. Use it to check that the endpoint is reachable and that its signature check accepts MyPilotIndex’s signature. The answer is 202 once the ping is queued, before it is delivered; each call is one ping with a new event id. The webhook URL and its secret are set by MyPilotIndex when the partner is approved: a partner without a webhook URL, with a URL that is not https, or without a secret on record answers 409 conflict with reason webhook_not_configured, and nothing is queued. The request has no body (an empty JSON object is accepted). Like every partner call it counts toward the daily allowance and is logged.

POST /v1/partner/webhooks/test

Send a test ping to the webhook

cURL

curl --request POST \
  --url https://{devApiHost}/v1/partner/webhooks/test \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{}'

400

{
  "error": {
    "code": "invalid_request",
    "message": "<string>",
    "correlation_id": "<string>",
    "reason": "<string>"
  }
}

Authorizations

Authorization · string · header · required

OAuth 2.0 client credentials. Request a token from the token endpoint of the identity provider's domain (https://{cognito-domain}/oauth2/token, with HTTP Basic client authentication) and send it as a Bearer token. Production uses auth.mypilotindex.com. The sandbox uses the dev environment's Cognito domain, which is given to the partner with its sandbox credential. A token carries only the scopes the partner was approved for.

Body

application/json

Maximum 4096 bytes. None, or an empty JSON object.

The body is of type object.

Response

202

The ping is queued for delivery.