Skip to main content
PATCH
/
webhooks
/
{webhookId}
Update a webhook
curl --request PATCH \
  --url https://api.arkhq.io/v1/webhooks/{webhookId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "url": "<string>",
  "events": [
    "<string>"
  ],
  "allEvents": true,
  "enabled": true
}
'
{
  "success": true,
  "data": {
    "id": "456",
    "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "url": "<string>",
    "events": [
      "MessageSent"
    ],
    "allEvents": true,
    "enabled": true,
    "createdAt": "2023-11-07T05:31:56Z"
  },
  "meta": {
    "requestId": "req_V1StGXR8_Z5jdHi6"
  }
}

Authorizations

Authorization
string
header
required

Use your API key from arkhq.io/org/credentials

Authorization: Bearer YOUR_API_KEY

Path Parameters

webhookId
string
required

Body

application/json
name
string | null
url
string<uri> | null
events
string[] | null
allEvents
boolean | null
enabled
boolean | null

Response

Webhook updated

success
boolean
required
data
object
required
meta
object
required