Get all webhook actions | API Reference

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

{
  "ANNOTATIONS_CREATED": {
    "description": "Triggered when one or more annotations are created in a project.",
    "key": "annotations_created",
    "name": "Annotations Created",
    "organization-only": false
  },
  "ANNOTATIONS_DELETED": {
    "description": "Triggered when one or more annotations are deleted from a project.",
    "key": "annotations_deleted",
    "name": "Annotations Deleted",
    "organization-only": false
  },
  "ANNOTATION_CREATED": {
    "description": "Triggered when a single annotation is created.",
    "key": "annotation_created",
    "name": "Annotation Created",
    "organization-only": false
  },
  "ANNOTATION_UPDATED": {
    "description": "Triggered when an existing annotation is updated.",
    "key": "annotation_updated",
    "name": "Annotation Updated",
    "organization-only": false
  },
  "LABEL_LINK_CREATED": {
    "description": "Triggered when a label link is created between annotations.",
    "key": "label_link_created",
    "name": "Label Link Created",
    "organization-only": false
  },
  "LABEL_LINK_DELETED": {
    "description": "Triggered when a label link is deleted.",
    "key": "label_link_deleted",
    "name": "Label Link Deleted",
    "organization-only": false
  },
  "LABEL_LINK_UPDATED": {
    "description": "Triggered when a label link is updated.",
    "key": "label_link_updated",
    "name": "Label Link Updated",
    "organization-only": false
  },
  "PROJECT_CREATED": {
    "description": "Triggered when a new project is created within the organization.",
    "key": "project_created",
    "name": "Project Created",
    "organization-only": true
  },
  "PROJECT_DELETED": {
    "description": "Triggered when a project is deleted from the organization.",
    "key": "project_deleted",
    "name": "Project Deleted",
    "organization-only": true
  },
  "PROJECT_UPDATED": {
    "description": "Triggered when a project is updated or modified.",
    "key": "project_updated",
    "name": "Project Updated",
    "organization-only": true
  },
  "REVIEWS_DELETED": {
    "description": "Triggered when one or more reviews are deleted.",
    "key": "reviews_deleted",
    "name": "Reviews Deleted",
    "organization-only": false
  },
  "REVIEW_CREATED": {
    "description": "Triggered when a new review is created.",
    "key": "review_created",
    "name": "Review Created",
    "organization-only": false
  },
  "REVIEW_UPDATED": {
    "description": "Triggered when an existing review is updated.",
    "key": "review_updated",
    "name": "Review Updated",
    "organization-only": false
  },
  "TASKS_CREATED": {
    "description": "Triggered when new tasks are created in a project.",
    "key": "tasks_created",
    "name": "Tasks Created",
    "organization-only": false
  },
  "TASKS_DELETED": {
    "description": "Triggered when tasks are deleted from a project.",
    "key": "tasks_deleted",
    "name": "Tasks Deleted",
    "organization-only": false
  }
}

Get descriptions of all available webhook actions to set up webhooks.

Authentication

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

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: <br><pre><code class="language-bash">curl https://label-studio-host/api/projects -H "Authorization: Token [your-token]"</code></pre>

Query parameters

organization-onlybooleanOptional

organization-only or not

Response

Object with webhook action descriptions.

ANNOTATIONS_CREATEDobject

ANNOTATIONS_DELETEDobject

ANNOTATION_CREATEDobject

ANNOTATION_UPDATEDobject

LABEL_LINK_CREATEDobject

LABEL_LINK_DELETEDobject

LABEL_LINK_UPDATEDobject

PROJECT_CREATEDobject

PROJECT_DELETEDobject

PROJECT_UPDATEDobject

REVIEWS_DELETEDobject

REVIEW_CREATEDobject

REVIEW_UPDATEDobject

TASKS_CREATEDobject

TASKS_DELETEDobject