Application WebhooksUpdate application webhook

Update application webhook

Updates the URL or active status of a webhook configuration.

curl -X PATCH "https://api.example.com/api/v1/applications/example_string/webhooks/example_string" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN (JWT)" \
  -d '{
  "url": "https://merchant.example.com/hooks/v2",
  "isActive": true
}'
{
  "id": "8a1c2f9e-3d4b-4f5a-9b6c-7d8e9f0a1b2c",
  "url": "https://merchant.example.com/webhooks/kadosei",
  "isActive": true,
  "keyFingerprint": "whsec_****a3f2",
  "signingSecret": "whsec_full_secret_value",
  "subscribedEvents": [
    "session.completed",
    "session.expired"
  ],
  "lastTestAt": "2026-04-20T12:34:56.000Z",
  "lastTestStatus": "SUCCEEDED",
  "createdAt": "2026-01-15T08:00:00.000Z",
  "updatedAt": "2026-04-01T09:30:00.000Z"
}
PATCH
/api/v1/applications/{applicationId}/webhooks/{webhookId}
PATCH
Base URLstring

Target server for requests. Edit to use your own host.

Bearer Token (JWT)
Bearer Tokenstring
Required

Bearer token (JWT) - just enter the token, "Bearer" prefix will be added automatically

path
applicationIdstring
Required

ID of the application that owns the webhook.

path
webhookIdstring
Required

ID of the webhook configuration to update.

Content-Typestring
Required

The media type of the request body

Options: application/json
urlstring

HTTPS endpoint on the merchant server that receives webhooks.

isActiveboolean

Whether this webhook configuration is active.

Request Preview
Response

Response will appear here after sending the request

Authentication

header
Authorizationstring
Required

Bearer token (JWT). Authentication token required.

Path Parameters

applicationIdstring
Required

ID of the application that owns the webhook.

webhookIdstring
Required

ID of the webhook configuration to update.

Body

application/json
urlstring

HTTPS endpoint on the merchant server that receives webhooks.

Example:
https://merchant.example.com/hooks/v2
isActiveboolean

Whether this webhook configuration is active.

Example:
true

Responses

idstring
Required

ID of the webhook configuration.

urlstring
Required

Endpoint URL that receives webhook deliveries.

isActiveboolean
Required

Whether this webhook configuration is currently active.

keyFingerprintstring
Required

Fingerprint of the signing key used to sign webhook deliveries.

signingSecretstring

Webhook signing secret. Only returned when creating a webhook; store securely.

subscribedEventsstring[]
Required

Event types this webhook is subscribed to.

lastTestAtstring
Required

Timestamp of the most recent test delivery, if any.

lastTestStatusstring
Required

Status of the most recent test delivery, if any.

createdAtstring
Required

When this webhook configuration was created.

updatedAtstring
Required

When this webhook configuration was last updated.