POST
/
webhooks
curl --request POST \
  --url https://api.formo.so/api/webhooks \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "formId": "<string>",
  "targetUrl": "<string>",
  "eventTypes": [
    "FORM_SUBMISSION"
  ]
}'
{
  "isSuccess": true,
  "data": {
    "webhookId": "<string>"
  }
}

Creates or updates a webhook subscription for receiving form events.

Need help finding your Form ID? Check out our guide on Locating Your Form ID.

​
Event Types

  • FORM_SUBMISSION - Triggered when a form submission is received
  • FORM_UPDATED - Triggered when a form is updated

​
Notes

  • If a webhook subscription already exists for the same form and target URL, the event types will be merged with existing ones
  • Duplicate event types are automatically removed
  • Only FORM_SUBMISSION and FORM_UPDATED are valid event types
  • The webhook will be automatically activated upon creation

Authorizations

​
x-api-key
string
header
required

Body

application/json
​
formId
string
required

The unique identifier of the form

​
targetUrl
string
required

The URL that will receive webhook events

​
eventTypes
enum<string>[]
required

Types of events to subscribe to

Available options:
FORM_SUBMISSION,
FORM_UPDATED

Response

200
application/json
Successfully subscribed to webhook
​
isSuccess
boolean
Example:

true

​
data
object
Raise issue