Sign in

v1

latestOpenAPI 3.0.32026-07-23194968.1 KB
Webhooks

Get webhooks

Retrieve all webhooks in the organization.

Required permissions, when user-scoped authentication is used: MANAGE_WEB_HOOK.

get/api/v1/organization/webhooks

Query parameters

orgIdinteger

Organization ID (optional). If not provided, the organization, that is associated with the authentication token, will be used.

Response

List of webhooks

idinteger

Webhook ID

namestring

Webhook name

trigger'NEW_USER' | 'DELETED_USER' | 'UPDATED_USER' | 'DEVICE_ADDED' | 'DEVICE_DELETED' | 'DEVICE_DATASTREAM_UPDATE' | 'PRODUCT_DATASTREAM_UPDATE' | 'GLOBAL_PRODUCT_DATASTREAM_UPDATE' | 'DEVICE_LOG_EVENT' | 'PRODUCT_LOG_EVENT' | 'GLOBAL_PRODUCT_LOG_EVENT' | 'FIRST_DEVICE_CONNECTION_IN_ORG' | 'ORGANIZATION_ADDED'

Webhook trigger type

dataTriggerobject

Data trigger configuration (for datastream or log event triggers)

urlstring

Webhook URL. Supports placeholders such as {device_id}, {user_id}.

method'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH'

HTTP method for webhook

contentType'PLAIN_TEXT' | 'JSON' | 'URL_ENCODED_FORM'

Content type of the webhook request

authType'NONE' | 'BASIC' | 'OAUTH2'

Authentication type

bodystring

Request body template

formBodyobject

URL-encoded form body key-value pairs (used when contentType is URL_ENCODED_FORM)

oAuth2Requestobject

OAuth2 configuration (used when authType is OAUTH2)

failureReceiversinteger[]

User IDs to notify on webhook failure

status'ENABLED' | 'DISABLED' | 'DISABLED_DUE_TO_ERRORS'

Webhook status

attemptCountinteger

Total number of execution attempts

createdAtinteger

Creation timestamp in milliseconds

lastModifiedTsinteger

Last modification timestamp in milliseconds

lastTriggeredTsinteger

Last trigger timestamp in milliseconds

failureLimitinteger

Number of consecutive failures before the webhook is disabled