Skip to main content
Loading...

API docs by

ping
Webhook

Request

The ping event type is used to test webhook connectivity.

Bodyapplication/jsonrequired
typestringrequired

The event type

Value:"ping"
timestampstring, (date-time)required

When the webhook event occurred

attemptedAtstring, (date-time)required

When the delivery was attempted

webhookEventIdstringrequired

ID of the associated webhook event

webhookIdstringrequired

ID of the webhook that notified your endpoint

webhookobjectrequired
POST
ping
Payload
{
  "type": "ping",
  "timestamp": "2019-08-24T14:15:22Z",
  "attemptedAt": "2019-08-24T14:15:22Z",
  "webhookEventId": "string",
  "webhookId": "string",
  "webhook": {
    "id": "string"
  }
}

Responses

Return a 2XX status to acknowledge the event.