Subscribe URL to webhook event

Webhooks

POST

/webhooks/{eventName}/subscriptions

Parameters

Path Parameters

eventName*

The event name to subscribe to.

Type

string

Required

Request Body

application/json

{

  

"url": "https://callback.example.com",

  

"username": "username for Basic Auth.",

  

"secret": "password for Basic Auth.",

  

"auth_type": "aws_sigv4",

  

"role_arn": "arn:aws:iam::123456789012:role/GainsightWebhookRole",

  

"external_id": "gainsight-customer-prod-2026",

  

"region": "us-west-2",

  

"service": "execute-api"

}

Responses

URL subscribed

Samples