Webhooks

Archive a webhook

Archive (soft delete) a webhook by its ID. It stops receiving deliveries but its delivery history remains available.

Authorization

Public key Secret key
x-fngs-public-key<token>

In: header

x-fngs-secret-key<token>

In: header

Path Parameters

webhookId*string

Unique identifier (UUID) of the webhook.

Formatuuid

Request Body

application/json

PATCH /v0/webhooks/:webhookId/archive Request body

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

PATCH
/v0/webhooks/{webhookId}/archive
curl -X PATCH "https://example.com/v0/webhooks/497f6eca-6276-4993-bfeb-53cbbbba6f08/archive" \  -H "Content-Type: application/json" \  -d '{}'
{  "status": "success",  "data": {    "success": true  }}

Update a webhook PATCH

Update a webhook's URL, status, secret, or subscribed events. Any field omitted from the request is left unchanged. Passing 'events' replaces the full set of subscribed event types.

List a webhook's delivery attempts GET

Retrieve delivery attempt history for a specific webhook, newest first — whether an event was delivered, the HTTP response received, and how many retries occurred.