Update webhook info | API Reference

Authentication

AuthorizationToken

The token (or API key) must be passed as a request header. You can find your user token on the User Account page in Label Studio. Example:

curl https://label-studio-host/api/projects -H “Authorization: Token [your-token]”

The token (or API key) must be passed as a request header. You can find your user token on the User Account page in Label Studio. Example: <br><pre><code class="language-bash">curl https://label-studio-host/api/projects -H "Authorization: Token [your-token]"</code></pre>

Path parameters

idintegerRequired

Request

This endpoint expects an object.

actionslist of enumsOptional

headersanyOptional

Key Value Json of headers

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-2048 characters

URL of webhook

Response

created_atdatetimeRead-only

Creation time

idintegerRead-only

organizationintegerRead-only

projectinteger or nullRead-only

updated_atdatetimeRead-only

Last update time

urlstringformat: "uri"<=2048 characters

URL of webhook

actionslist of enums

headersany

Key Value Json of headers

is_activeboolean

If value is False the webhook is disabled

send_for_all_actionsboolean

If value is False - used only for actions from WebhookAction

send_payloadboolean

If value is False send only action

$	curl -X PATCH http://localhost:8000/api/webhooks/1/ \
>	-H "Authorization: Token <api_key>" \
>	-H "Content-Type: application/json" \
>	-d '{}'

1	{
2	"created_at": "2024-01-15T09:30:00Z",
3	"id": 1,
4	"organization": 42,
5	"project": 7,
6	"updated_at": "2024-01-15T09:30:00Z",
7	"url": "https://hooks.labelstud.io/webhook/1",
8	"actions": [
9	"PROJECT_CREATED"
10	],
11	"headers": null,
12	"is_active": true,
13	"send_for_all_actions": true,
14	"send_payload": true
15	}

$	curl -X PATCH http://localhost:8000/api/webhooks/1/ \
>	-H "Authorization: Token <api_key>" \
>	-H "Content-Type: application/json" \
>	-d '{}'

1	{
2	"created_at": "2024-01-15T09:30:00Z",
3	"id": 1,
4	"organization": 42,
5	"project": 7,
6	"updated_at": "2024-01-15T09:30:00Z",
7	"url": "https://hooks.labelstud.io/webhook/1",
8	"actions": [
9	"PROJECT_CREATED"
10	],
11	"headers": null,
12	"is_active": true,
13	"send_for_all_actions": true,
14	"send_payload": true
15	}