Update a Webhook

put

{base_url}/api/webhook/v1/webhooks/{webhook_uuid}

Replaces the configuration of an existing outbound webhook subscription. This is a full replacement, not a partial update: every attribute in the request body (URL, status, name, originator identifier, basic auth credentials, HMAC secret) is overwritten, and any attribute omitted is cleared. Always send the complete desired state, otherwise stored credentials are lost. A supplied webhook_event_type must still be one the Developer Partner is entitled to. An unknown, deleted, or other-partner webhook_uuid returns 404 and an invalid status returns 400.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

webhook_uuid

string

required

Body Params

webhook_url

string

required

URL for the webhook

webhook_name

string

required

name for the webhook

originator_identifier

string

required

originator identifier for the webhook

status

string

enum

required

Status of the webhook

Allowed:

webhook_event_type

string

enum

required

Type for the webhook event. Must match the event type the webhook was created with; the event type of an existing webhook cannot be changed. To receive a different event type, register a new webhook

basic_auth_username

string

required

basic_auth_username for the webhook

basic_auth_secret

string

required

basic_auth_secret for the webhook

hmac_secret

string

required

hmac_secret for the webhook

Responses

400

bad_request

401

unauthorized request

403

forbidden - not entitled to claimed_offer on update

404

not found

200webhook updated