LogoLogo
EnterpriseQuick Start
API ReferenceTutorials
  • Introduction
    • Getting started
  • API Reference
EnterpriseQuick Start
API ReferenceWebhooks

PATCH
http://localhost:8000/api/webhooks/:id/
PATCH
/api/webhooks/:id/
1curl -X PATCH http://localhost:8000/api/webhooks/1/ \
2     -H "Authorization: Token  <api_key>" \
3     -H "Content-Type: application/json" \
4     -d '{}'
Try it
200Updated
1{
2  "created_at": "2024-01-15T09:30:00Z",
3  "id": 1,
4  "organization": 1,
5  "updated_at": "2024-01-15T09:30:00Z",
6  "url": "url",
7  "actions": [
8    "PROJECT_CREATED"
9  ],
10  "headers": {
11    "key": "value"
12  },
13  "is_active": true,
14  "project": 1,
15  "send_for_all_actions": true,
16  "send_payload": true
17}
Was this page helpful?
Previous

List workspaces

Next
Built with
List workspaces

Path parameters

idintegerRequired

Headers

AuthorizationstringRequired
Header authentication of the form `Token <token>`

Request

This endpoint expects an object.
actionslist of enumsOptional
headersanyOptional
is_activebooleanOptional
If value is False the webhook is disabled
send_for_all_actionsbooleanOptional

If value is False - used only for actions from WebhookAction

send_payloadbooleanOptional
If value is False send only action
urlstringOptionalformat: "uri">=1 character<=2048 characters
URL of webhook

Response

created_atdatetime
Creation time
idinteger
organizationinteger
updated_atdatetime
Last update time
urlstringformat: "uri"<=2048 characters
URL of webhook
actionslist of enums or null
headersany or null
is_activeboolean or null
If value is False the webhook is disabled
projectinteger or null
send_for_all_actionsboolean or null

If value is False - used only for actions from WebhookAction

send_payloadboolean or null
If value is False send only action
Update webhook info

Header authentication of the form Token <token>