Update a webhook

PUT

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

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
webhookIdpath stringRequired webhook ObjectId. Owner/Admin access and ownership of the webhook are required.
webhookUrlbody stringOptional complete URL. Unlike create, update does not add https://.
isWebhookOnbody booleanOptional delivery switch.
webhookSecretbody stringOptional signing secret. An empty value disables signing.
verifySSLbody booleanOptional boolean. true verifies the destination HTTPS certificate (recommended); false disables certificate verification.

Returns webhookInfo as one object, not an array. Send only the four documented mutable settings, using JSON booleans. Ownership/form IDs and update operators are rejected. URLs must be complete public HTTP/HTTPS URLs without embedded credentials. verifySSL controls HTTPS certificate verification for live, test and redelivery requests; keep it true. Store your signing secret in protected server configuration.

Example request

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

JSON request body

{
  "webhookUrl": "https://example.com/hooks/rapidoform",
  "isWebhookOn": true
}

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.