Webhooks

Send a test event

Sends a webhook.test event to this endpoint only, once, even if it's disabled, and answers with the delivery and how the try went. The event's data.object is the endpoint, never its secret. Tests and redeliveries share a budget of 100 an hour per workspace.

Needs an API key with the generations:write scope.

post/v1/webhook_endpoints/{id}/test

Request

  • Base URL: https://api.tryleap.ai
  • URL: https://api.tryleap.ai/v1/webhook_endpoints/{id}/test
  • Auth: one of:
    • API key in header x-api-key
    • HTTP bearer

Path parameters

idstring required

The endpoint's ID, we_....

Response

The delivery, with the try's result.

idstring required

The delivery's ID, whd_....

object'webhook_delivery' required
eventstring required

The event it carries, evt_....

endpointstring nullable required

The endpoint, or null for the webhook URL a request named.

urlstring required

Where it goes.

status'pending' | 'succeeded' | 'failed' required

pending while tries remain, succeeded once your server answered 2xx, failed after the last try.

next_attempt_atstring date-time nullable required

When Leap tries again; null once it succeeded or gave up.

created_atstring date-time required

When it was queued.

completed_atstring date-time nullable required

When it succeeded or Leap gave up; null while tries remain.

Changes

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