Webhooks
Overview
Webhooks allow you to receive responses in real-time. You can use Webhooks to integrate with your own system, or to send responses to other services. You can refer to the Webhook Overview for more information.
Create Webhook
To create a Webhook, you can send a POST request to /api/v1/webhooks.
Create a webhook.
Request parameters
{
"id": "12345abcde",
"webhookUrl": "https://example.com/webhook"
}
Responses
{
"webhookSecret": "GDzIn77nt83fhfcVQD8hWcqXY3jM49pc"
}
{
"errorCode": 401001,
"message": "Invalid access token"
}
{
"errorCode": 401003,
"message": "Authorization header is missing"
}
{
"errorCode": 401004,
"message": "Authorization type is not Bearer"
}
{
"errorCode": 401005,
"message": "Access token is expired, please refresh"
}
{
"errorCode": 401006,
"message": "User not found"
}
{
"errorCode": 403000,
"message": "You do not have permission to access this resource."
}
{
"errorCode": 404003,
"message": "Form not found."
}
Delete Webhook
To delete a Webhook, you can send a DELETE request to /api/v1/webhooks/{webhookId}.
Delete a webhook.
Request parameters
{
"id": "12345abcde",
"webhookUrl": "https://example.com/webhook"
}
Responses
{
"errorCode": 401001,
"message": "Invalid access token"
}
{
"errorCode": 401003,
"message": "Authorization header is missing"
}
{
"errorCode": 401004,
"message": "Authorization type is not Bearer"
}
{
"errorCode": 401005,
"message": "Access token is expired, please refresh"
}
{
"errorCode": 401006,
"message": "User not found"
}
{
"errorCode": 403000,
"message": "You do not have permission to access this resource."
}
{
"errorCode": 404003,
"message": "Form not found."
}
{
"errorCode": 404004,
"message": "Webhook not found."
}
Last modified: 08 December 2023