Skip to main content
PATCH
Update a webhook

Authorizations

x-fngs-public-key
string
header
required
x-fngs-secret-key
string
header
required

Path Parameters

webhookId
string<uuid>
required

Unique identifier (UUID) of the webhook.

Body

application/json

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

url
string<url>

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

status
enum<string>

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

Available options:
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.

Minimum string length: 16
events
enum<string>[]

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

Available options:
payment_success,
payment_refunded,
payment_failed,
subscription_created,
subscription_interval,
subscription_updated,
subscription_cancelled

Response

PATCH /v0/webhooks/:webhookId/update Positive response

status
string
required
Allowed value: "success"
data
object
required