Webhook endpoints
Update Webhook Endpoint
Update a webhook endpoint. All fields are optional; only the provided fields are updated.
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 PATCH "https://example.com/webhook-endpoints/string" \ -H "Content-Type: application/json" \ -d '{}'{ "id": "string", "url": "string", "eventTypes": [ "document.uploaded" ], "createdAt": "2019-08-24T14:15:22Z"}Send Test Event POST
Send a test event to a webhook endpoint. The endpoint must be subscribed to the requested event type.
Document Uploaded Webhook
Triggered when a document is uploaded and available for download. Deliveries are signed with the `FileForms-Signature` header and retried automatically on failure; see the [webhook guides](https://docs.fileforms.com/guides/webhooks/setup-and-verification) for delivery, retry, and signature verification.