Create a webhook

POST

https://www.rapidoform.com/be/api/webhook/save

All requests require X-EMAIL and X-API-KEY. See authentication and errors. JSON request bodies also require Content-Type: application/json. All IDs in examples are synthetic; replace them with your own values.

Parameters

NameType / locationDescription
surveyIdbody stringRequired form ID. You must be its creator and an Owner or Admin.
webhookUrlbody stringRequired destination URL. Use a complete HTTPS URL.

Creation only saves surveyId and webhookUrl. It starts with isWebhookOn: true, webhookSecret: "" and verifySSL: true. Configure other fields using Update a webhook. Returns the form creator’s webhook list. URLs must target public HTTP/HTTPS servers without embedded credentials; use HTTPS.

Example request

curl --request POST 'https://www.rapidoform.com/be/api/webhook/save' \
  --header "X-EMAIL: $RAPIDOFORM_EMAIL" \
  --header "X-API-KEY: $RAPIDOFORM_API_KEY" \
  --header 'Content-Type: application/json' \
  --data '{"surveyId":"12345","webhookUrl":"https://example.com/hooks/rapidoform"}'

JSON request body

{
  "surveyId": "12345",
  "webhookUrl": "https://example.com/hooks/rapidoform"
}

Response

Examples show selected fields, not every stored property. Empty arrays are valid for list/report endpoints.

{
  "Errors": [],
  "Info": [],
  "Data": [
    {
      "webhookInfo": [
        {
          "_id": "000000000000000000000003",
          "surveyId": "12345",
          "webhookUrl": "https://example.com/hooks/rapidoform",
          "isWebhookOn": true,
          "webhookSecret": "",
          "verifySSL": true
        }
      ]
    }
  ],
  "ErrorCode": "SUCCESS",
  "fieldErrors": {
    "List": []
  }
}

HTTP 200 alone does not indicate success. Check ErrorCode and Errors; see troubleshooting.