PATCH
/
api
/
v1
/
webhook-endpoints
/
{endpoint_id}
Update a Webhook Endpoint
curl --request PATCH \
  --url http://localhost:8080/api/v1/webhook-endpoints/{endpoint_id} \
  --header 'Content-Type: application/json' \
  --data '
{
  "rotate_secret": true,
  "url": "<string>"
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "updated_at": "2023-11-07T05:31:56Z",
  "url": "<string>",
  "venture_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "secret": "<string>"
}

Path Parameters

​
endpoint_id
string<uuid>
required

Endpoint UUID

Body

application/json
​
rotate_secret
boolean

Rotate the signing secret. Returned ONCE.

​
status
null | enum<string>

Whether an endpoint receives deliveries.

Available options:
ACTIVE,
DISABLED
​
url
string | null

Response

Updated; rotated secret returned ONCE

Response to an endpoint update. secret is present only when rotated (ONCE).

​
id
string<uuid>
required
​
status
enum<string>
required

Whether an endpoint receives deliveries.

Available options:
ACTIVE,
DISABLED
​
updated_at
string<date-time>
required
​
url
string
required
​
venture_id
string<uuid>
required
​
secret
string | null