logofirst
logofirst

Set up webhooks in Label Studio

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 example:

{
    "action": "TASK_CREATED",
    "tasks": [
        {"id": 1, ...},
        ...
    ]
}

Your application or service can then respond to that event information however you want.

What to use Label Studio webhooks for

Some events that happen in Label Studio happen in response to an API call. For those, the API response is sufficient to know that the action has occurred. But other events happen inside the Label Studio UI, such as project changes and task annotation activities. To find out immediately when those changes occur, you can use webhooks to notify your application or machine learning pipeline to take specific actions.

The actions your webhook takes in your application or pipeline can vary depending on the event. For example, you might use events sent to your webhook URL to do the following:

Limit the number of requests to your server by subscribing only to the events relevant for your use case.

Available Label Studio webhooks

Label Studio makes two main types of events available to integrate with webhooks: project-level task events and organization events.

Event Action Details Use Case
Task Created For a specific project, triggers when new tasks are created. One event per import action. Bulk task creation is sent as one event. Use to take action in your machine learning pipeline.
Task Deleted For a specific project, triggers when tasks are deleted. One event per deletion action. Bulk task deletion is sent as one event. Use to update a training dataset version.
Annotation Created For a specific project, triggers when new annotations are created for any tasks. One event per annotation. Use to start training in an active learning scenario.
Annotation Updated For a specific project, triggers when an existing annotation is updated, overwritten, or when a task is skipped. Use to prompt model retraining.
Annotation Deleted For a specific project, triggers when an annotation is deleted. Bulk annotation deletion is sent as one event. Use to create a new version of a training dataset.
Project Created For an organization, triggers when a project is created. You must enable organization-level webhooks to send this event. Use to create a new pipeline for data management.
Project Updated Triggers when project settings, such as the labeling configuration, are updated, created, or saved. Use to update an existing data management pipeline.
Project Deleted For an organization, triggers when a project is deleted. You must enable organization-level webhooks to send this event. Use to remove a data management pipeline.

Enable organization-level webhooks

To use the organization-level webhooks that trigger events for each project, you must set an environment variable.

LABEL_STUDIO_ALLOW_ORGANIZATION_WEBHOOKS=true

How to integrate with webhooks

To integrate with webhooks in Label Studio, you must do the following:

  1. Create a webhook endpoint or URL as part of your application or machine learning model pipeline.
  2. Make sure the webhook endpoint or URL is accessible to your Label Studio instance and can accept HTTP POST requests.
  3. Add the webhook to Label Studio.

Set up your webhook endpoint to read the event payload from Label Studio and take action based on the event.

Add a new webhook in Label Studio

Set up a webhook URL in Label Studio and associate it with one or more event triggers. You can set up a webhook URL in the Label Studio UI, or using the API. You can configure as many webhook connections as you want, but too many might overwhelm your instance.

Add a webhook in Label Studio UI

Add a webhook URL to Label Studio. The webhook URL must be set up to accept HTTP POST requests.

  1. In the Label Studio UI, open the project that you want to associate with a webhook URL.
  2. Click Settings and click Webhooks.
  3. Click Add Webhook.
  4. In the Payload URL field, provide the URL to send event payloads to. For example, https://www.example.com/webhook.
  5. (Optional) Toggle the Is Active option to deactivate the webhook until it is ready to use. Otherwise, the webhook becomes active as soon as you save it and events are sent to the URL.
  6. (Optional) Click the + sign to add any headers required by the webhook URL. Specify the header name and the value. You can use headers to authenticate a request to your webhook URL. For example, Authorization and Basic bGFiZWxzdHVkaW86ZXhhbXBsZQ==
  7. (Optional) Select whether to send a payload with the event. By default, payloads are sent. If you don’t send a payload, only the action key is sent. For example, choose to send the payload for Annotation created events to update the correct pipeline based on the project ID sent in the payload.
  8. (Optional) Select whether to send an event for all actions in Label Studio supported by webhooks, or specific events. By default, events are sent for all actions. For example, select the Annotation created event.
  9. Save the webhook.

Add a webhook using the Label Studio API

Make a POST request to the Create a webhook endpoint to add a webhook using the API. If you want to extend webhooks with custom events, see Create a custom webhook event.

Troubleshoot a webhook connection

Webhook connections time out after 1 second. You can adjust the timeout by setting an environment variable, WEBHOOK_TIMEOUT.

If the webhook URL is inaccessible by Label Studio, you can see this in a traceback in the logs.

Label Studio does not retry webhook connections that fail. You can see successful webhook deliveries in the logs in DEBUG mode.