API reference

Update webhook

Update URL / events / active flag without rotating the secret.

PATCH/api/v1/webhooks/{id}

Step-by-step guideStep 1 of 3

Select a stage to see what happens.

Your integration

Request readyIllustrative example

PATCH/webhooks/{id}

Authorization: Bearer ••••••••
Accept: application/json

Prepare the request

Use credentials for the selected environment and complete the required parameters.

Illustrative flow · no data is sent

How this endpoint works

Update routing metadata on an existing subscription. The signing secret is preserved — your handler's verification keeps working. Pass only the fields you want to change. To rotate the secret, use the dedicated /rotate-secret endpoint.

Server-side authentication

Authentication guide

Request parameters

Expand a field to see its format and requirements.

urlstring

New HTTPS endpoint. Same validation rules as POST /webhooks.

eventsstring[]

Replace the events list. Send the full new array — there's no add-only mode.

activeboolean

Pause deliveries without deleting. Disabled subs reject deliveries silently.

descriptionstring

Free-form label (≤240 chars). Pass `null` to clear.

CODE EXAMPLESIllustrative

bash

curl -X PATCH https://sandbox.key2pay.ai/api/v1/webhooks/wh_3f6c7b1… \
  -H "Authorization: Bearer sk_test_51N8mP...exampleK3Y" \
  -H "Content-Type: application/json" \
  -d '{ "events": ["payment.completed", "payment.failed", "chargeback.created"] }'

json

{
  "id": "wh_3f6c7b…",
  "url": "https://acme.com/webhooks/key2pay",
  "events": ["payment.completed", "payment.failed", "chargeback.created"],
  "active": true,
  "description": "Production handler",
  "createdAt": "2026-05-10T18:00:00.000Z",
  "updatedAt": "2026-05-12T18:00:00.000Z"
}

Example response. No request was sent.