Webhooks

Update webhook info

PATCH

Path parameters

idintegerRequired
A unique integer value identifying this webhook.

Query parameters

urlstringRequired
URL of webhook
send_payloadbooleanOptional
If value is False send only action
send_for_all_actionsbooleanOptional
If value is False - used only for actions from WebhookAction
headersstringOptional
Key Value Json of headers
is_activebooleanOptional
If value is False the webhook is disabled
actionsenumOptional

Request

This endpoint expects an object.
url
stringRequired
URL of webhook
id
integerOptional
organization
integerOptional
project
integerOptional
send_payload
booleanOptional
If value is False send only action
send_for_all_actions
booleanOptional
If value is False - used only for actions from WebhookAction
headers
map from strings to anyOptional
Key Value Json of headers
is_active
booleanOptional
If value is False the webhook is disabled
actions
list of enumsOptional
created_at
datetimeOptional
Creation time
updated_at
datetimeOptional
Last update time

Response

This endpoint returns an object
url
string
URL of webhook
id
integerOptional
organization
integerOptional
project
integerOptional
send_payload
booleanOptional
If value is False send only action
send_for_all_actions
booleanOptional
If value is False - used only for actions from WebhookAction
headers
map from strings to anyOptional
Key Value Json of headers
is_active
booleanOptional
If value is False the webhook is disabled
actions
list of enumsOptional
created_at
datetimeOptional
Creation time
updated_at
datetimeOptional
Last update time
PATCH
1curl -X PATCH "http://localhost:8080/api/webhooks/1/?url=url" \
2 -H "Authorization: Token <api_key>" \
3 -H "Content-Type: application/json" \
4 -d '{
5 "url": "url"
6}'
200Updated
1{
2 "url": "url",
3 "id": 1,
4 "organization": 1,
5 "project": 1,
6 "send_payload": true,
7 "send_for_all_actions": true,
8 "headers": {
9 "headers": {
10 "key": "value"
11 }
12 },
13 "is_active": true,
14 "actions": [
15 "PROJECT_CREATED"
16 ],
17 "created_at": "2024-01-15T09:30:00Z",
18 "updated_at": "2024-01-15T09:30:00Z"
19}