Skip to main content
PUT
/
edges
/
https
/
{edge_id}
/
routes
/
{id}
/
webhook_verification
Replace
curl --request PUT \
  --url https://api.ngrok.com/edges/https/{edge_id}/routes/{id}/webhook_verification \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'ngrok-version: <ngrok-version>' \
  --data '{
  "edge_id": "<string>",
  "id": "<string>",
  "module": {
    "enabled": true,
    "provider": "<string>",
    "secret": "<string>"
  }
}'
{
  "enabled": true,
  "provider": "<string>",
  "secret": "<string>"
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

ngrok-version
integer
default:2
required

Path Parameters

edge_id
string
required
id
string
required

Body

application/json
edge_id
string

n/a

id
string

n/a

module
object

n/a

Response

200 - application/json

n/a

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-verification

secret
string

a string secret used to validate requests from the given provider. All providers except AWS SNS require a secret