Get webhook info

GET

http://localhost:8000/api/webhooks/:id/

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>

Path parameters

idintegerRequired

Response

consecutive_failuresintegerRead-only

created_atdatetimeRead-only

Creation time

idintegerRead-only

organizationintegerRead-only

updated_atdatetimeRead-only

Last update time

urlstringformat: "uri"<=2048 characters

URL of webhook

actionslist of enumsOptionalDefaults to []

headersanyOptional

Key Value Json of headers

is_activebooleanOptional

If value is False the webhook is disabled

projectinteger or nullOptional

send_for_all_actionsbooleanOptional

If value is False - used only for actions from WebhookAction

send_payloadbooleanOptional

If value is False send only action

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

1	{
2	"consecutive_failures": 1,
3	"created_at": "2024-01-15T09:30:00Z",
4	"id": 1,
5	"organization": 1,
6	"updated_at": "2024-01-15T09:30:00Z",
7	"url": "string",
8	"actions": [
9	"PROJECT_CREATED"
10	],
11	"headers": null,
12	"is_active": true,
13	"project": 1,
14	"send_for_all_actions": true,
15	"send_payload": true
16	}