Update a webhook

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.

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/update Request body

TypeScript Definitions

Use the request body type in TypeScript.

url?string

HTTP(S) endpoint that receives event deliveries. Must use http:// or https:// and must not resolve to a loopback, private, or link-local address.

Formaturl

status?string

Whether the webhook receives deliveries: - active: Receives deliveries for its subscribed events - inactive: Configured but not currently receiving deliveries

Value in

"active"
"inactive"

secret?string

Caller-supplied signing secret used to verify the 'x-fngs-signature' header on each delivery. Any string of at least 16 characters — no required prefix or format.

Length16 <= length

events?array<>

Event types this webhook is subscribed to. Omit to subscribe to no events.

Response Body

`application/json`

curl -X PATCH "https://example.com/v0/webhooks/497f6eca-6276-4993-bfeb-53cbbbba6f08/update" \  -H "Content-Type: application/json" \  -d '{}'

{  "status": "success",  "data": {    "webhook": {      "object": "webhook",      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "url": "string",      "status": "active",      "secret": "string",      "events": [        "payment_success"      ],      "lastBlockReason": "malformed_url",      "lastBlockedAt": null,      "consecutiveFailures": 0,      "failingSince": null,      "createdAt": 0,      "deletedAt": null    }  }}

Update a webhook

Authorization

Path Parameters

Request Body

Response Body

200application/json

400application/json

`application/json`

`application/json`