Skip to main content
POST
Create webhook subscription
Creates a new webhook subscription. Note: You must verify the HMAC-SHA256 signature using the raw request body.

Authorizations

Authorization
string
header
required

OAuth 2.0 client-credentials access token. Obtain one from https://auth.alvys.com/oauth/token (grant_type=client_credentials, audience=https://api.alvys.com/public/), then paste it here. The playground sends it as Authorization: Bearer <token>.

Path Parameters

version
string
default:1.0
required

API version (e.g., 1.0)

Example:

"1.0"

Body

Name
string
required
Minimum string length: 1
SubsidiaryId
string
required
Minimum string length: 1
Url
string
required
Required string length: 1 - 2048
Events
string[]
required
IncludePreviousAttributes
boolean
required

Response

Created

Id
string
required
CompanyCode
string
required
SubsidiaryId
string
required
Name
string
required
Url
string
required
Secret
string
required
Events
string[]
required
Status
string
required
ConsecutiveFailures
integer<int32>
required
CreatedAt
string<date-time>
required
CreatedBy
string
required
IncludePreviousAttributes
boolean
required
DisabledAt
string<date-time> | null
DisabledReason
string | null
UpdatedAt
string<date-time> | null
UpdatedBy
string | null
LastTriggeredAt
string<date-time> | null