FileForms
Webhook endpoints

Send Test Event

POST
/webhook-endpoints/{id}/test

Send a test event to a webhook endpoint. The endpoint must be subscribed to the requested event type.

Authorization

ApiKeyAuth
x-api-key<token>

In: header

Path Parameters

id*string

Webhook endpoint ID (we_...)

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/webhook-endpoints/string/test" \  -H "Content-Type: application/json" \  -d '{    "eventType": "document.uploaded"  }'
{  "delivered": true,  "eventId": "string"}

Retry Failed Deliveries POST

Re-queue every failed delivery of the endpoint for the next automatic retry sweep (runs every few minutes). Retried events keep their original `id` and payload, so consumers must deduplicate on the event `id`.

Update Webhook Endpoint PATCH

Update a webhook endpoint. All fields are optional; only the provided fields are updated.