Get all webhook actions

GET

http://localhost:8000/api/webhooks/info/

GET

/api/webhooks/info/

$ curl http://localhost:8000/api/webhooks/info/ \
>      -H "Authorization: Token  <api_key>"

200Retrieved

1 {
2   "ANNOTATIONS_CREATED": {
3     "description": "string",
4     "key": "string",
5     "name": "string",
6     "organization-only": true
7   },
8   "ANNOTATIONS_DELETED": {
9     "description": "string",
10     "key": "string",
11     "name": "string",
12     "organization-only": true
13   },
14   "ANNOTATION_CREATED": {
15     "description": "string",
16     "key": "string",
17     "name": "string",
18     "organization-only": true
19   },
20   "ANNOTATION_UPDATED": {
21     "description": "string",
22     "key": "string",
23     "name": "string",
24     "organization-only": true
25   },
26   "LABEL_LINK_CREATED": {
27     "description": "string",
28     "key": "string",
29     "name": "string",
30     "organization-only": true
31   },
32   "LABEL_LINK_DELETED": {
33     "description": "string",
34     "key": "string",
35     "name": "string",
36     "organization-only": true
37   },
38   "LABEL_LINK_UPDATED": {
39     "description": "string",
40     "key": "string",
41     "name": "string",
42     "organization-only": true
43   },
44   "PROJECT_CREATED": {
45     "description": "string",
46     "key": "string",
47     "name": "string",
48     "organization-only": true
49   },
50   "PROJECT_DELETED": {
51     "description": "string",
52     "key": "string",
53     "name": "string",
54     "organization-only": true
55   },
56   "PROJECT_UPDATED": {
57     "description": "string",
58     "key": "string",
59     "name": "string",
60     "organization-only": true
61   },
62   "REVIEWS_DELETED": {
63     "description": "string",
64     "key": "string",
65     "name": "string",
66     "organization-only": true
67   },
68   "REVIEW_CREATED": {
69     "description": "string",
70     "key": "string",
71     "name": "string",
72     "organization-only": true
73   },
74   "REVIEW_UPDATED": {
75     "description": "string",
76     "key": "string",
77     "name": "string",
78     "organization-only": true
79   },
80   "TASKS_CREATED": {
81     "description": "string",
82     "key": "string",
83     "name": "string",
84     "organization-only": true
85   },
86   "TASKS_DELETED": {
87     "description": "string",
88     "key": "string",
89     "name": "string",
90     "organization-only": true
91   }
92 }

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

ANNOTATIONS_DELETEDobjectOptional

ANNOTATION_CREATEDobjectOptional

ANNOTATION_UPDATEDobjectOptional

LABEL_LINK_CREATEDobjectOptional

LABEL_LINK_DELETEDobjectOptional

LABEL_LINK_UPDATEDobjectOptional

PROJECT_CREATEDobjectOptional

PROJECT_DELETEDobjectOptional

PROJECT_UPDATEDobjectOptional

REVIEWS_DELETEDobjectOptional

REVIEW_CREATEDobjectOptional

REVIEW_UPDATEDobjectOptional

TASKS_CREATEDobjectOptional

TASKS_DELETEDobjectOptional