Skip to main content
PATCH
/
api
/
v1
/
webhook-endpoints
/
{id}
Update a webhook endpoint
curl --request PATCH \
  --url http://localhost:3001/api/v1/webhook-endpoints/{id} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <x-api-key>' \
  --data '
{
  "url": "<string>",
  "description": {},
  "events": [
    "<string>"
  ]
}
'
{
  "success": true,
  "data": {
    "id": "<string>",
    "url": "<string>",
    "events": [
      "<string>"
    ],
    "status": "<string>",
    "signingSecretHint": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "businessId": {},
    "partnerId": {},
    "description": {},
    "apiVersion": {}
  }
}

Headers

​
x-api-key
string
required

Path Parameters

​
id
string
required

Body

application/json
​
url
string
​
description
object
​
events
string[]
​
status
enum<string>
Available options:
ENABLED,
DISABLED

Response

OK

​
success
boolean
required
Example:

true

​
data
object
required