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.

urlstring=1 character

URL of webhook

idintegerOptional

organizationintegerOptional

projectintegerOptional

send_payloadbooleanOptional

If value is False send only action

send_for_all_actionsbooleanOptional

If value is False - used only for actions from WebhookAction

headersmap from strings to anyOptional

Key Value Json of headers

is_activebooleanOptional

If value is False the webhook is disabled

actionslist of enumsOptional

created_atdatetimeOptional

Creation time

updated_atdatetimeOptional

Last update time

Create a webhook

Up Next

Built with

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	"key": "value"
11	},
12	"is_active": true,
13	"actions": [
14	"PROJECT_CREATED"
15	],
16	"created_at": "2024-01-15T09:30:00Z",
17	"updated_at": "2024-01-15T09:30:00Z"
18	}
19	]

1	curl http://localhost:8080/api/webhooks/ \
2	-H "Authorization: Token <api_key>"