Skip to main content
PATCH
/
v1
/
webhook_endpoints
/
{id}
Update
curl --request PATCH \
  --url https://{defaultHost}/v1/webhook_endpoints/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "webhook_endpoint": {
    "enabled": false
  }
}
'
{
  "id": "820be9ff-60bf-4b93-a48b-1a8b0cdf479d",
  "object": "webhook_endpoint",
  "automation_service": null,
  "description": null,
  "enabled": false,
  "erroring_grace_period_ends_at": null,
  "erroring_grace_period_started_at": null,
  "webhook_events": [],
  "signing_secret": "VoJJ3CyQSCoYHzwrsk4sMSQZ",
  "url": "http://padberg.test/caterina_ferry",
  "created_at": 1767909789,
  "updated_at": 1767909789
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
id
string
required

Body

application/json
​
webhook_endpoint
object

Response

200 - application/json

Success

​
id
string | null

The UUID of the specific object.

​
object
string

A string describing the object type returned.

​
description
string | null

An optional description of what this webhook endpoint is used for.

​
enabled
boolean

Whether or not this webhook endpoint is active.

​
url
string

The URL of this webhook endpoint.

​
webhook_events
string[]

The webhook events that this webhook endpoint should send webhooks for. For example, if webhook_events=["order.created"] then the webhook endpoint will only send webhooks when the order.created event occurs.

​
automation_service
string | null

The automation service that this webhook endpoint is pointed at. One of suretriggers or zapier.

​
erroring_grace_period_ends_at
integer | null

The time at which this webhook endpoint will be disabled if it continues to error.

​
erroring_grace_period_started_at
integer | null

The time at which this webhook endpoint started erroring. A webhook endpoint is considered to be erroring when it returns a non 2xx response code. After 3 days, with 40% or more of requests erroring, the webhook endpoint will be disabled.

​
signing_secret
string

The webhook endpoint’s signing secret, used to generate webhook signatures.

​
created_at
integer | null

Time at which the object was created. Measured in seconds since the Unix epoch.

​
updated_at
integer | null

Time at which the object was last updated. Measured in seconds since the Unix epoch.