This document is about creating new webhooks using the API. Webhooks can also be created directly by users through the user interface by accessing the Moaform service. For instructions on creating webhooks directly within the Moaform service, please refer to Webhook > Creating Webhooks.
You can create a new webhook for a specific form (form_id
) using the API.
[POST] https://api.moaform.com/forms/{form_id}/webhooks
REQUEST
Path Parameters
Key | Description |
---|---|
form_id | Required. Unique ID of the form |
Body
PARAMETER | TYPE | DESCRIPTION |
---|---|---|
endpoint | string | Required. Webhook receiver URL |
enabled | boolean | Webhook activation status, default value: false |
secret | string | Secret code, default value: null |
verify_ssl | boolean | Endpoint SSL certificate verification status, default value: true |
retention_days | integer | Resend restriction days (choose from 1, 3, 5, 7, 10, 15, 30), default value: 7 |
For detailed explanations of each setting, please refer to Webhook > Creating Webhooks.
RESPONSE
Key | Type | Description |
---|---|---|
id | string | Unique ID of the webhook |
endpoint | string | Endpoint of the webhook |
enabled | boolean | Activation status of the webhook |
secret | string | Secret code |
verify_ssl | boolean | Endpoint SSL certificate verification status |
retention_days | integer | Days limit for resending |
created_at | string | Webhook creation timestamp |
updated_at | string | Webhook modification timestamp |