Retrieve webhooks

GET

https://www.rapidoform.com/be/api/webhook/info/:surveyId

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
surveyIdpath numberRequired form ID.

Requires access to the form’s workspace (or ownership of the form). Returns the form creator’s webhook list, consistently with creation. Member responses omit webhookSecret.

Example request

curl --request GET 'https://www.rapidoform.com/be/api/webhook/info/12345' \
  --header "X-EMAIL: $RAPIDOFORM_EMAIL" \
  --header "X-API-KEY: $RAPIDOFORM_API_KEY"

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.