Webhooks

List all webhooks

GET

List all webhooks set up for your organization.

Webhooks in Label Studio let you set up integrations that subscribe to certain events that occur inside Label Studio. When an event is triggered, Label Studio sends an HTTP POST request to the configured webhook URL.

For more information, see Set up webhooks in Label Studio.

Query parameters

projectstringOptional
Project ID

Response

This endpoint returns a list of objects
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
GET
1curl http://localhost:8080/api/webhooks/ \
2 -H "Authorization: Token <api_key>"
200Retrieved
1[
2 {
3 "url": "url",
4 "id": 1,
5 "organization": 1,
6 "project": 1,
7 "send_payload": true,
8 "send_for_all_actions": true,
9 "headers": {
10 "headers": {
11 "key": "value"
12 }
13 },
14 "is_active": true,
15 "actions": [
16 "PROJECT_CREATED"
17 ],
18 "created_at": "2024-01-15T09:30:00Z",
19 "updated_at": "2024-01-15T09:30:00Z"
20 }
21]