Get webhook info | API Reference

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]”

idintegerRequired

created_atdatetimeRead-only

Creation time

idintegerRead-only

organizationintegerRead-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

projectinteger or null

send_for_all_actionsboolean

If value is False - used only for actions from WebhookAction

send_payloadboolean

If value is False send only action

1	{
2	"created_at": "2024-01-15T09:30:00Z",
3	"id": 1,
4	"organization": 42,
5	"updated_at": "2024-04-10T14:45:00Z",
6	"url": "https://hooks.example.com/webhook/1",
7	"actions": [
8	"PROJECT_CREATED",
9	"TASKS_CREATED",
10	"ANNOTATION_UPDATED"
11	],
12	"headers": {
13	"Authorization": "Bearer abcdef1234567890",
14	"Content-Type": "application/json"
15	},
16	"is_active": true,
17	"project": 101,
18	"send_for_all_actions": true,
19	"send_payload": true
20	}

1	{
2	"created_at": "2024-01-15T09:30:00Z",
3	"id": 1,
4	"organization": 42,
5	"updated_at": "2024-04-10T14:45:00Z",
6	"url": "https://hooks.example.com/webhook/1",
7	"actions": [
8	"PROJECT_CREATED",
9	"TASKS_CREATED",
10	"ANNOTATION_UPDATED"
11	],
12	"headers": {
13	"Authorization": "Bearer abcdef1234567890",
14	"Content-Type": "application/json"
15	},
16	"is_active": true,
17	"project": 101,
18	"send_for_all_actions": true,
19	"send_payload": true
20	}

$	curl http://localhost:8000/api/webhooks/1/ \
>	-H "Authorization: Token <api_key>" \
>	-H "Content-Type: application/json"