Webhooks

Update a webhook

Updates an existing webhook. Send only the fields you want to change. The https-only URL rule from webhook creation applies here too. Moving a webhook to the other mode re-checks that mode's webhook cap, so an update can be rejected if the target mode is already full.

put/v2/webhooks/{webhookId}

Request

  • Base URL: https://test-api.kashier.io
  • URL: https://test-api.kashier.io/v2/webhooks/{webhookId}
  • Auth: API key in header Authorization

Path parameters

webhookIdstring required

The webhook's _id, from List your webhooks or Create a webhook.

Request body

namestring

Your label for the webhook.

urlstring uri

The endpoint Kashier delivers to. Must be a public https URL — non-https schemes, localhost, loopback, link-local, and private (RFC-1918) addresses are rejected.

headersobject

Custom headers to send with every delivery to this webhook, as a flat string-to-string map.

eventsWebhookEvent[]

The event types a webhook is subscribed to.

mode'test' | 'live'

The webhook only receives events emitted in this mode.

isActiveboolean

Whether the webhook is enabled.

Response

The updated webhook, in the same shape as an entry in the list response.

_idstring

Unique identifier for the webhook — this is the webhookId used in Update a webhook and Delete a webhook.

merchantIdstring

The merchant the webhook belongs to.

namestring

Your label for the webhook.

urlstring uri

The endpoint Kashier delivers to.

headersobject

Custom headers Kashier sends with every delivery to this webhook, as a flat string-to-string map.

eventsWebhookEvent[]

The event types a webhook is subscribed to.

mode'test' | 'live'

The webhook only receives events emitted in this mode.

isActiveboolean

Whether the webhook currently receives deliveries.

createdAtstring date-time
updatedAtstring date-time

Example response

{
  "_id": "66a1f2c3e4b0a1234567890a",
  "merchantId": "MID-10293"
}

Changes

No recorded changes to this operation across all 1 revision of this API.