Update webhook

Update a webhook's label, url, events, or active state. Setting active to true also clears an automatic disable. Requires the admin scope.

PATCH

/api/v2/settings/webhooks/{id}

PATCH

/settings/webhooks/{id}

curl -X PATCH "https://productlane.com/api/v2/settings/webhooks/{id}" \
  -H "Authorization: Bearer $PRODUCTLANE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "label": "string",
  "url": "https://example.com",
  "events": [
    "string"
  ],
  "active": true
}'

Authorization

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

Parameters

id
string
path
required

Body

application/json

label
string
url
string<uri>
events
string[]
active
boolean

Response

application/json

Successful response

id
string
required
label
string
required
url
string
required
events
string[]
required
active
boolean
required
disabled_at
string | null
required
created_at
string
required
updated_at
string
required

{
  "id": "string",
  "label": "string",
  "url": "string",
  "events": [
    "string"
  ],
  "active": true,
  "disabled_at": "string",
  "created_at": "string",
  "updated_at": "string"
}