Webhooks

Create a webhook

POST

Create a webhook. Label Studio provides several out-of-the box webhook events, which you can find listed here: Available Label Studio webhooks.

If you want to create your own custom webhook, refer to Create custom events for webhooks in Label Studio.

Label Studio makes two main types of events available to integrate with webhooks: project-level task events and organization events. If you want to use organization-level webhook events, you will need to set LABEL_STUDIO_ALLOW_ORGANIZATION_WEBHOOKS=true.

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
POST
1curl -X POST http://localhost:8080/api/webhooks/ \
2 -H "Authorization: Token <api_key>" \
3 -H "Content-Type: application/json" \
4 -d '{
5 "url": "url"
6}'
200Successful
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}