POST https://webhook.example.com

Subscribe to this event to receive periodic ping messages used to validate that your webhook endpoint is reachable and functioning properly.

application/json

Body

  • id string Required

    Minimum length is 1.

  • correlationId string Required

    Minimum length is 1.

  • entity string Required

    Value is Ping.

  • version string Required

    Minimum length is 1.

  • webhookConfigurationId string Required

    Minimum length is 1.

  • data object Required
    Hide data attribute Show data attribute object
    • ping string Required

      Minimum length is 1.

Responses

  • 200

    Your server returns this code if it successfully processed the event

  • 201

    Your server returns this code if it successfully processed the event

  • 202

    Your server returns this code if it successfully processed the event

  • 204

    Your server returns this code if it successfully processed the event

POST PingWebhook
Request examples 
{
  "id": "string",
  "correlationId": "string",
  "entity": "Ping",
  "version": "string",
  "webhookConfigurationId": "string",
  "data": {
    "ping": "string"
  }
}