Skip to main content
PATCH
/
v1
/
webhooks
/
{id}
Update a webhook
curl --request PATCH \
  --url https://api.reader.dev/v1/webhooks/{id} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "url": "<string>",
  "name": "<string>",
  "events": [
    "<string>"
  ],
  "secret": "<string>",
  "headers": {},
  "active": true
}
'
{
  "success": true,
  "data": {
    "id": "<string>",
    "url": "<string>",
    "name": "<string>",
    "events": [
      "<string>"
    ],
    "headers": {},
    "active": true,
    "deliveryStats": {
      "totalAttempts": 123,
      "failedDeliveries": 123,
      "lastDeliveryAt": "2023-11-07T05:31:56Z",
      "lastDeliveryStatus": 123
    },
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "secret": "<string>"
  }
}
Patch any subset of a webhook’s fields: url, name, events, headers, or active. The secret cannot be updated through this endpoint; delete and recreate the webhook if you need to rotate it.

Authorizations

x-api-key
string
header
required

Path Parameters

id
string
required

Body

application/json
url
string<uri>
name
string
Required string length: 1 - 100
events
string[]
Minimum array length: 1
secret
string
Required string length: 16 - 256
headers
object
active
boolean

Response

Updated webhook

success
enum<boolean>
required
Available options:
true
data
object
required