# Webhooks
Webhook management for event-driven integrations
## Get webhooks
> Retrieve all webhooks in the organization.\
> \
> Required permissions, when user-scoped authentication is used: \`MANAGE\_WEB\_HOOK\`.
```json
{"openapi":"3.0.3","info":{"title":"Blynk Platform API","version":"1.0.0"},"tags":[{"name":"Webhooks","description":"Webhook management for event-driven integrations"}],"servers":[{"url":"https://{server_address}","description":"Blynk Server","variables":{"server_address":{"default":"blynk.cloud","description":"Your Blynk server domain"}}}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"OAuth2 Bearer token obtained from authentication endpoint"}},"schemas":{"Webhook":{"type":"object","properties":{"id":{"type":"integer","format":"int32","description":"Webhook ID"},"name":{"type":"string","description":"Webhook name"},"trigger":{"type":"string","description":"Webhook trigger type","enum":["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"]},"dataTrigger":{"type":"object","description":"Data trigger configuration (for datastream or log event triggers)"},"url":{"type":"string","description":"Webhook URL. Supports placeholders such as `{device_id}`, `{user_id}`.","maxLength":512},"method":{"type":"string","description":"HTTP method for webhook","enum":["GET","POST","PUT","DELETE","PATCH"]},"contentType":{"type":"string","description":"Content type of the webhook request","enum":["PLAIN_TEXT","JSON","URL_ENCODED_FORM"]},"authType":{"type":"string","description":"Authentication type","enum":["NONE","BASIC","OAUTH2"]},"body":{"type":"string","description":"Request body template","maxLength":1024},"formBody":{"type":"object","additionalProperties":{"type":"string"},"description":"URL-encoded form body key-value pairs (used when contentType is URL_ENCODED_FORM)"},"queryParams":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"value":{"type":"string"}}},"maxItems":20,"description":"Query parameters"},"basicAuthCredentials":{"type":"object","properties":{"name":{"type":"string","description":"Username"},"value":{"type":"string","description":"Password"}},"description":"Basic auth credentials (used when authType is BASIC)"},"oAuth2Request":{"type":"object","description":"OAuth2 configuration (used when authType is OAUTH2)"},"headers":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"value":{"type":"string"}}},"maxItems":20,"description":"Custom HTTP headers"},"failureReceivers":{"type":"array","items":{"type":"integer","format":"int64"},"maxItems":10,"description":"User IDs to notify on webhook failure"},"status":{"type":"string","description":"Webhook status","enum":["ENABLED","DISABLED","DISABLED_DUE_TO_ERRORS"]},"attemptCount":{"type":"integer","format":"int32","description":"Total number of execution attempts"},"createdAt":{"type":"integer","format":"int64","description":"Creation timestamp in milliseconds"},"lastModifiedTs":{"type":"integer","format":"int64","description":"Last modification timestamp in milliseconds"},"lastTriggeredTs":{"type":"integer","format":"int64","description":"Last trigger timestamp in milliseconds"},"failureLimit":{"type":"integer","format":"int32","description":"Number of consecutive failures before the webhook is disabled"}}},"ErrorResponse":{"type":"object","properties":{"error":{"type":"object","properties":{"message":{"type":"string","description":"Error message"}},"required":["message"]}},"required":["error"]}}},"paths":{"/api/v1/organization/webhooks":{"get":{"tags":["Webhooks"],"summary":"Get webhooks","description":"Retrieve all webhooks in the organization.\n\nRequired permissions, when user-scoped authentication is used: `MANAGE_WEB_HOOK`.\n","operationId":"getWebhooks","parameters":[{"name":"orgId","in":"query","schema":{"type":"integer","format":"int32"},"description":"Organization ID (optional). If not provided, the organization, that is associated with the authentication token, will be used."}],"responses":{"200":{"description":"List of webhooks","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Webhook"}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Forbidden"},"404":{"description":"Organization not found or access denied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Too many requests"},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}}}
```
## Get webhook
> Retrieve a single webhook by ID.\
> \
> Required permissions, when user-scoped authentication is used: \`MANAGE\_WEB\_HOOK\`.
```json
{"openapi":"3.0.3","info":{"title":"Blynk Platform API","version":"1.0.0"},"tags":[{"name":"Webhooks","description":"Webhook management for event-driven integrations"}],"servers":[{"url":"https://{server_address}","description":"Blynk Server","variables":{"server_address":{"default":"blynk.cloud","description":"Your Blynk server domain"}}}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"OAuth2 Bearer token obtained from authentication endpoint"}},"schemas":{"Webhook":{"type":"object","properties":{"id":{"type":"integer","format":"int32","description":"Webhook ID"},"name":{"type":"string","description":"Webhook name"},"trigger":{"type":"string","description":"Webhook trigger type","enum":["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"]},"dataTrigger":{"type":"object","description":"Data trigger configuration (for datastream or log event triggers)"},"url":{"type":"string","description":"Webhook URL. Supports placeholders such as `{device_id}`, `{user_id}`.","maxLength":512},"method":{"type":"string","description":"HTTP method for webhook","enum":["GET","POST","PUT","DELETE","PATCH"]},"contentType":{"type":"string","description":"Content type of the webhook request","enum":["PLAIN_TEXT","JSON","URL_ENCODED_FORM"]},"authType":{"type":"string","description":"Authentication type","enum":["NONE","BASIC","OAUTH2"]},"body":{"type":"string","description":"Request body template","maxLength":1024},"formBody":{"type":"object","additionalProperties":{"type":"string"},"description":"URL-encoded form body key-value pairs (used when contentType is URL_ENCODED_FORM)"},"queryParams":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"value":{"type":"string"}}},"maxItems":20,"description":"Query parameters"},"basicAuthCredentials":{"type":"object","properties":{"name":{"type":"string","description":"Username"},"value":{"type":"string","description":"Password"}},"description":"Basic auth credentials (used when authType is BASIC)"},"oAuth2Request":{"type":"object","description":"OAuth2 configuration (used when authType is OAUTH2)"},"headers":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"value":{"type":"string"}}},"maxItems":20,"description":"Custom HTTP headers"},"failureReceivers":{"type":"array","items":{"type":"integer","format":"int64"},"maxItems":10,"description":"User IDs to notify on webhook failure"},"status":{"type":"string","description":"Webhook status","enum":["ENABLED","DISABLED","DISABLED_DUE_TO_ERRORS"]},"attemptCount":{"type":"integer","format":"int32","description":"Total number of execution attempts"},"createdAt":{"type":"integer","format":"int64","description":"Creation timestamp in milliseconds"},"lastModifiedTs":{"type":"integer","format":"int64","description":"Last modification timestamp in milliseconds"},"lastTriggeredTs":{"type":"integer","format":"int64","description":"Last trigger timestamp in milliseconds"},"failureLimit":{"type":"integer","format":"int32","description":"Number of consecutive failures before the webhook is disabled"}}},"ErrorResponse":{"type":"object","properties":{"error":{"type":"object","properties":{"message":{"type":"string","description":"Error message"}},"required":["message"]}},"required":["error"]}}},"paths":{"/api/v1/organization/webhook":{"get":{"tags":["Webhooks"],"summary":"Get webhook","description":"Retrieve a single webhook by ID.\n\nRequired permissions, when user-scoped authentication is used: `MANAGE_WEB_HOOK`.\n","operationId":"getWebhook","parameters":[{"name":"webhookId","in":"query","required":true,"schema":{"type":"integer","format":"int32"},"description":"Webhook ID"}],"responses":{"200":{"description":"Webhook details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Webhook"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Forbidden"},"404":{"description":"Webhook not found or access denied"},"429":{"description":"Too many requests"},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}}}
```
## Update webhook
> Update an existing webhook.\
> \
> Required permissions, when user-scoped authentication is used: \`MANAGE\_WEB\_HOOK\`.
```json
{"openapi":"3.0.3","info":{"title":"Blynk Platform API","version":"1.0.0"},"tags":[{"name":"Webhooks","description":"Webhook management for event-driven integrations"}],"servers":[{"url":"https://{server_address}","description":"Blynk Server","variables":{"server_address":{"default":"blynk.cloud","description":"Your Blynk server domain"}}}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"OAuth2 Bearer token obtained from authentication endpoint"}},"schemas":{"Webhook":{"type":"object","properties":{"id":{"type":"integer","format":"int32","description":"Webhook ID"},"name":{"type":"string","description":"Webhook name"},"trigger":{"type":"string","description":"Webhook trigger type","enum":["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"]},"dataTrigger":{"type":"object","description":"Data trigger configuration (for datastream or log event triggers)"},"url":{"type":"string","description":"Webhook URL. Supports placeholders such as `{device_id}`, `{user_id}`.","maxLength":512},"method":{"type":"string","description":"HTTP method for webhook","enum":["GET","POST","PUT","DELETE","PATCH"]},"contentType":{"type":"string","description":"Content type of the webhook request","enum":["PLAIN_TEXT","JSON","URL_ENCODED_FORM"]},"authType":{"type":"string","description":"Authentication type","enum":["NONE","BASIC","OAUTH2"]},"body":{"type":"string","description":"Request body template","maxLength":1024},"formBody":{"type":"object","additionalProperties":{"type":"string"},"description":"URL-encoded form body key-value pairs (used when contentType is URL_ENCODED_FORM)"},"queryParams":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"value":{"type":"string"}}},"maxItems":20,"description":"Query parameters"},"basicAuthCredentials":{"type":"object","properties":{"name":{"type":"string","description":"Username"},"value":{"type":"string","description":"Password"}},"description":"Basic auth credentials (used when authType is BASIC)"},"oAuth2Request":{"type":"object","description":"OAuth2 configuration (used when authType is OAUTH2)"},"headers":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"value":{"type":"string"}}},"maxItems":20,"description":"Custom HTTP headers"},"failureReceivers":{"type":"array","items":{"type":"integer","format":"int64"},"maxItems":10,"description":"User IDs to notify on webhook failure"},"status":{"type":"string","description":"Webhook status","enum":["ENABLED","DISABLED","DISABLED_DUE_TO_ERRORS"]},"attemptCount":{"type":"integer","format":"int32","description":"Total number of execution attempts"},"createdAt":{"type":"integer","format":"int64","description":"Creation timestamp in milliseconds"},"lastModifiedTs":{"type":"integer","format":"int64","description":"Last modification timestamp in milliseconds"},"lastTriggeredTs":{"type":"integer","format":"int64","description":"Last trigger timestamp in milliseconds"},"failureLimit":{"type":"integer","format":"int32","description":"Number of consecutive failures before the webhook is disabled"}}},"ErrorResponse":{"type":"object","properties":{"error":{"type":"object","properties":{"message":{"type":"string","description":"Error message"}},"required":["message"]}},"required":["error"]}}},"paths":{"/api/v1/organization/webhook":{"put":{"tags":["Webhooks"],"summary":"Update webhook","description":"Update an existing webhook.\n\nRequired permissions, when user-scoped authentication is used: `MANAGE_WEB_HOOK`.\n","operationId":"updateWebhook","parameters":[{"name":"webhookId","in":"query","required":true,"schema":{"type":"integer","format":"int32"},"description":"Webhook ID"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","maxLength":100,"description":"Webhook name"},"trigger":{"type":"string","description":"Webhook trigger type","enum":["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"]},"dataTrigger":{"type":"object","description":"Data trigger configuration"},"url":{"type":"string","maxLength":512,"description":"Webhook URL. Supports placeholders such as `{device_id}`, `{user_id}`."},"method":{"type":"string","enum":["GET","POST","PUT","DELETE","PATCH"],"description":"HTTP method"},"contentType":{"type":"string","enum":["PLAIN_TEXT","JSON","URL_ENCODED_FORM"],"description":"Content type"},"authType":{"type":"string","enum":["NONE","BASIC","OAUTH2"],"description":"Authentication type"},"body":{"type":"string","maxLength":1024,"description":"Request body template"},"formBody":{"type":"object","additionalProperties":{"type":"string"},"description":"URL-encoded form body"},"queryParams":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"value":{"type":"string"}}},"maxItems":20},"basicAuthCredentials":{"type":"object","properties":{"name":{"type":"string"},"value":{"type":"string"}}},"oAuth2Request":{"type":"object"},"headers":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"value":{"type":"string"}}},"maxItems":20},"failureReceivers":{"type":"array","items":{"type":"integer","format":"int64"},"maxItems":10},"status":{"type":"string","enum":["ENABLED","DISABLED","DISABLED_DUE_TO_ERRORS"],"description":"Webhook status. `DISABLED_DUE_TO_ERRORS` is set automatically by the system and is ignored if provided in an update request."},"failureLimit":{"type":"integer","format":"int32","description":"Failure limit"}},"required":["name","trigger","url","method","contentType","authType"]}}}},"responses":{"200":{"description":"Updated webhook","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Webhook"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Forbidden"},"404":{"description":"Webhook not found or access denied"},"429":{"description":"Too many requests"},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}}}
```
## Delete webhook
> Delete a webhook by ID.\
> \
> Required permissions, when user-scoped authentication is used: \`MANAGE\_WEB\_HOOK\`.
```json
{"openapi":"3.0.3","info":{"title":"Blynk Platform API","version":"1.0.0"},"tags":[{"name":"Webhooks","description":"Webhook management for event-driven integrations"}],"servers":[{"url":"https://{server_address}","description":"Blynk Server","variables":{"server_address":{"default":"blynk.cloud","description":"Your Blynk server domain"}}}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"OAuth2 Bearer token obtained from authentication endpoint"}},"schemas":{"ErrorResponse":{"type":"object","properties":{"error":{"type":"object","properties":{"message":{"type":"string","description":"Error message"}},"required":["message"]}},"required":["error"]}}},"paths":{"/api/v1/organization/webhook":{"delete":{"tags":["Webhooks"],"summary":"Delete webhook","description":"Delete a webhook by ID.\n\nRequired permissions, when user-scoped authentication is used: `MANAGE_WEB_HOOK`.\n","operationId":"deleteWebhook","parameters":[{"name":"webhookId","in":"query","required":true,"schema":{"type":"integer","format":"int32"},"description":"Webhook ID"}],"responses":{"204":{"description":"Webhook deleted successfully"},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Forbidden"},"404":{"description":"Webhook not found or access denied"},"429":{"description":"Too many requests"},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}}}
```
## Create webhook
> Create a new webhook in the organization.\
> \
> Required permissions, when user-scoped authentication is used: \`MANAGE\_WEB\_HOOK\`.
```json
{"openapi":"3.0.3","info":{"title":"Blynk Platform API","version":"1.0.0"},"tags":[{"name":"Webhooks","description":"Webhook management for event-driven integrations"}],"servers":[{"url":"https://{server_address}","description":"Blynk Server","variables":{"server_address":{"default":"blynk.cloud","description":"Your Blynk server domain"}}}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"OAuth2 Bearer token obtained from authentication endpoint"}},"schemas":{"Webhook":{"type":"object","properties":{"id":{"type":"integer","format":"int32","description":"Webhook ID"},"name":{"type":"string","description":"Webhook name"},"trigger":{"type":"string","description":"Webhook trigger type","enum":["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"]},"dataTrigger":{"type":"object","description":"Data trigger configuration (for datastream or log event triggers)"},"url":{"type":"string","description":"Webhook URL. Supports placeholders such as `{device_id}`, `{user_id}`.","maxLength":512},"method":{"type":"string","description":"HTTP method for webhook","enum":["GET","POST","PUT","DELETE","PATCH"]},"contentType":{"type":"string","description":"Content type of the webhook request","enum":["PLAIN_TEXT","JSON","URL_ENCODED_FORM"]},"authType":{"type":"string","description":"Authentication type","enum":["NONE","BASIC","OAUTH2"]},"body":{"type":"string","description":"Request body template","maxLength":1024},"formBody":{"type":"object","additionalProperties":{"type":"string"},"description":"URL-encoded form body key-value pairs (used when contentType is URL_ENCODED_FORM)"},"queryParams":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"value":{"type":"string"}}},"maxItems":20,"description":"Query parameters"},"basicAuthCredentials":{"type":"object","properties":{"name":{"type":"string","description":"Username"},"value":{"type":"string","description":"Password"}},"description":"Basic auth credentials (used when authType is BASIC)"},"oAuth2Request":{"type":"object","description":"OAuth2 configuration (used when authType is OAUTH2)"},"headers":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"value":{"type":"string"}}},"maxItems":20,"description":"Custom HTTP headers"},"failureReceivers":{"type":"array","items":{"type":"integer","format":"int64"},"maxItems":10,"description":"User IDs to notify on webhook failure"},"status":{"type":"string","description":"Webhook status","enum":["ENABLED","DISABLED","DISABLED_DUE_TO_ERRORS"]},"attemptCount":{"type":"integer","format":"int32","description":"Total number of execution attempts"},"createdAt":{"type":"integer","format":"int64","description":"Creation timestamp in milliseconds"},"lastModifiedTs":{"type":"integer","format":"int64","description":"Last modification timestamp in milliseconds"},"lastTriggeredTs":{"type":"integer","format":"int64","description":"Last trigger timestamp in milliseconds"},"failureLimit":{"type":"integer","format":"int32","description":"Number of consecutive failures before the webhook is disabled"}}},"ErrorResponse":{"type":"object","properties":{"error":{"type":"object","properties":{"message":{"type":"string","description":"Error message"}},"required":["message"]}},"required":["error"]}}},"paths":{"/api/v1/organization/webhook/create":{"post":{"tags":["Webhooks"],"summary":"Create webhook","description":"Create a new webhook in the organization.\n\nRequired permissions, when user-scoped authentication is used: `MANAGE_WEB_HOOK`.\n","operationId":"createWebhook","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"orgId":{"type":"integer","format":"int32","description":"Organization ID (optional). If not provided, the organization, that is associated with the authentication token, will be used."},"name":{"type":"string","maxLength":100,"description":"Webhook name"},"trigger":{"type":"string","description":"Webhook trigger type","enum":["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"]},"dataTrigger":{"type":"object","description":"Data trigger configuration (required for datastream and log event triggers)"},"url":{"type":"string","maxLength":512,"description":"Webhook URL. Supports placeholders such as `{device_id}`, `{user_id}`."},"method":{"type":"string","enum":["GET","POST","PUT","DELETE","PATCH"],"description":"HTTP method for webhook"},"contentType":{"type":"string","enum":["PLAIN_TEXT","JSON","URL_ENCODED_FORM"],"description":"Content type"},"authType":{"type":"string","enum":["NONE","BASIC","OAUTH2"],"description":"Authentication type"},"body":{"type":"string","maxLength":1024,"description":"Request body template"},"formBody":{"type":"object","additionalProperties":{"type":"string"},"description":"URL-encoded form body key-value pairs"},"queryParams":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"value":{"type":"string"}}},"maxItems":20,"description":"Query parameters"},"basicAuthCredentials":{"type":"object","properties":{"name":{"type":"string","description":"Username"},"value":{"type":"string","description":"Password"}},"description":"Basic auth credentials"},"oAuth2Request":{"type":"object","description":"OAuth2 configuration"},"headers":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"value":{"type":"string"}}},"maxItems":20,"description":"Custom HTTP headers"},"failureReceivers":{"type":"array","items":{"type":"integer","format":"int64"},"maxItems":10,"description":"User IDs to notify on webhook failure"},"failureLimit":{"type":"integer","format":"int32","description":"Number of consecutive failures before the webhook is disabled"}},"required":["name","trigger","url","method","contentType","authType"]}}}},"responses":{"201":{"description":"Webhook created successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Webhook"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Forbidden"},"404":{"description":"Organization not found or access denied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Too many requests"},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}}}
```
---
# Agent Instructions: Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter:
```
GET https://docs.blynk.io/en/blynk.cloud/platform-https-api/webhooks.md?ask=
```
The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.