Skip to content
Management API Reference

Send test event

post/v2/organizations/{slug}/webhooks/endpoints/{id}/test

Ingests and schedules a test webhook event to be published out this endpoints.

Which event type to use can be specified in the request body, otherwise it will use any matching type the endpoint is listening for.

The event will contain is_test: true in it's payload.

This endpoint is heavy rate-limited to allow for 10 request within 60 seconds.

Path parameters

  • slug
    Required
    string

    Organization slug

  • id
    Required
    string

    Identifier of an endpoint (UUID v7).

Body

  • data
    Optional
    object

Response codes

  • 201
  • 400
  • 401
  • 403
  • 404
  • 408
  • 429
  • 500

Response (201)

{
  "data": {
    "type": "ingress",
    "id": "lorem"
  }
}