Update a Webhook

patch

https://public-api.easyship.com/2024-09/webhooks/{webhook_id}

Update a single webhook in your account.

Required authorization scope: public.webhook:write

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

webhook_id

string

required

Webhook ID

Body Params

Update a Webhook. This is a partial update - only include the fields you want to change; any field left out is not modified. Unlike creating a webhook, version is not used to select a schema variant here, since it may be omitted.

version

string

enum

Webhook payload version. Refer to documentation for information regarding payload versioning.

Allowed:

endpoint

string

event_types

array of strings

length between 1 and 15

event_types

Allowed event types. Some event types are only valid for certain payload versions (e.g. transaction_record_create requires 2024-09 or later) - this is validated against the webhook's version separately, not by this schema.

configuration

object | null

Responses

Language

Credentials

Bearer

token

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200webhook successfully updated

422failed event_types validations