Skip to main content
POST
Register a webhook

Body

application/json
id
integer<int64>
serviceType
enum<string>
Available options:
GENERIC,
SLACK,
DISCORD,
TEAMS,
WORKATO
webhookUrl
string
description
string
eventTypes
enum<string>[]
Available options:
ASSESSMENT_COMPLETED,
ASSESSMENT_RECERTIFICATION_COMPLETED,
ASSESSMENT_REMEDIATION_COMPLETED,
ASSESSMENT_ARTIFACT_UPDATE_COMPLETED,
DOCS_ONLY_ARTIFACT_UPDATE_COMPLETED,
ASSESSMENT_REMINDER,
ASSESSMENT_CANCELLED,
ASSESSMENT_CANCELLED_BY_AUDITOR,
ASSESSMENT_AUTOMATICALLY_CANCELLED,
UPCOMING_RECERTIFICATION,
RELATIONSHIP_ONBOARDED,
RISK_ACCEPTED,
RELATIONSHIP_OVERDUE,
ARTIFACT_EXPIRING,
ARTIFACT_EXPIRED

Response

200 - application/json

OK

id
integer<int64>
description
string
eventTypes
string[]

The events that will trigger this webhook.

webhookUrl
string
serviceType
enum<string>
Available options:
GENERIC,
SLACK,
DISCORD,
TEAMS,
WORKATO