API ReferenceWebhooks

Create a webhook

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.

Headers

AuthorizationstringRequired

Header authentication of the form Token <token>

Request

This endpoint expects an object.
urlstringRequiredformat: "uri">=1 character<=2048 characters
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

Response

urlstringformat: "uri">=1 character<=2048 characters
URL of webhook
idinteger or null
organizationinteger or null
projectinteger or null
send_payloadboolean or null
If value is False send only action
send_for_all_actionsboolean or null

If value is False - used only for actions from WebhookAction

headersmap from strings to any or null
Key Value Json of headers
is_activeboolean or null
If value is False the webhook is disabled
actionslist of enums or null
created_atdatetime or null
Creation time
updated_atdatetime or null
Last update time