Update webhook info

PATCH

Update a webhook. You will need to provide the webhook ID. You can get this from List all webhooks.

For more information about webhooks, see Set up webhooks in Label Studio and the Webhook event reference.

Path parameters

idintegerRequired
A unique integer value identifying this webhook.

Query parameters

urlstringRequired
URL of webhook
send_payloadbooleanOptional
If value is False send only action
send_for_all_actionsbooleanOptional
If value is False - used only for actions from WebhookAction
headersstringOptional
Key Value Json of headers
is_activebooleanOptional
If value is False the webhook is disabled
actionsenumOptional

Request

This endpoint expects an object.
urlstringRequired
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

This endpoint returns an object.
urlstring
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
Built with