EdgeRouteWebhookVerificationModule

Get

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

Request

  • Base URL
    https://api.ngrok.com
  • URL
    https://api.ngrok.com/edges/https/{edge_id}/routes/{id}/webhook_verification
  • Auth
    HTTP bearer

Path parameters

edge_idstring required

unique identifier of this edge

idstring required

unique identifier of this edge route

Headers

ngrok-versioninteger required

Response

n/a

enabledboolean

true if the module will be applied to traffic, false to disable. default true if unspecified

providerstring

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

secretstring

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

Changes

No recorded changes to this operation across all 10 revisions of this API.