HTTPS Edge Route Webhook Verification Module

---

Replace HTTPS Edge Route Webhook Verification Module

Request

PUT /edges/https/{edge_id}/routes/{id}/webhook_verification

Example Request

curl \
-X PUT \
-H "Authorization: Bearer {API_KEY}" \
-H "Content-Type: application/json" \
-H "Ngrok-Version: 2" \
-d '{"enabled":true,"provider":"TWILIO","secret":"secret_token"}' \
https://api.ngrok.com/edges/https/edghts_2TMGJgYOrAZpG4wVt6WT9qndH3m/routes/edghtsrt_2TMGJjRd0eMDFnaAPTqfln3WC6m/webhook_verification

Parameters

enabled	boolean	true if the module will be applied to traffic, false to disable. default true if unspecified
provider	string	a string indicating which webhook provider will be sending webhooks to this endpoint. Value must be one of the supported providers defined at https://ngrok.com/docs/cloud-edge/modules/webhook
secret	string	a string secret used to validate requests from the given provider. All providers except AWS SNS require a secret

Response

Returns a 200 response on success

Example Response

{
  "enabled": true,
  "provider": "TWILIO",
  "secret": "secret_token"
}

Fields

enabled	boolean	true if the module will be applied to traffic, false to disable. default true if unspecified
provider	string	a string indicating which webhook provider will be sending webhooks to this endpoint. Value must be one of the supported providers defined at https://ngrok.com/docs/cloud-edge/modules/webhook
secret	string	a string secret used to validate requests from the given provider. All providers except AWS SNS require a secret

Get HTTPS Edge Route Webhook Verification Module

Request

GET /edges/https/{edge_id}/routes/{id}/webhook_verification

Example Request

curl \
-X GET \
-H "Authorization: Bearer {API_KEY}" \
-H "Ngrok-Version: 2" \
https://api.ngrok.com/edges/https/edghts_2TMGJgYOrAZpG4wVt6WT9qndH3m/routes/edghtsrt_2TMGJjRd0eMDFnaAPTqfln3WC6m/webhook_verification

Response

Returns a 200 response on success

Example Response

{
  "enabled": true,
  "provider": "TWILIO",
  "secret": "secret_token"
}

Fields

enabled	boolean	true if the module will be applied to traffic, false to disable. default true if unspecified
provider	string	a string indicating which webhook provider will be sending webhooks to this endpoint. Value must be one of the supported providers defined at https://ngrok.com/docs/cloud-edge/modules/webhook
secret	string	a string secret used to validate requests from the given provider. All providers except AWS SNS require a secret

Delete HTTPS Edge Route Webhook Verification Module

Request

DELETE /edges/https/{edge_id}/routes/{id}/webhook_verification

Example Request

curl \
-X DELETE \
-H "Authorization: Bearer {API_KEY}" \
-H "Ngrok-Version: 2" \
https://api.ngrok.com/edges/https/edghts_2TMGJgYOrAZpG4wVt6WT9qndH3m/routes/edghtsrt_2TMGJjRd0eMDFnaAPTqfln3WC6m/webhook_verification

Response

Returns a 204 response with no body on success