Skip to main content
POST
Create a new subscription for a contract

Authorizations

X-API-KEY
string
header
required

Body

application/json

Subscription to create

dataContractId
string<uuid>
required

Unique identifier of the contract

userId
string<uuid>

The unique identifier of the user

email
string

The email address of the subscriber if provided

Pattern: ^[a-zA-Z0-9_.+-]+@[a-zA-Z0-9-]+\.[a-zA-Z0-9-.]+$
githubHandle
string

The GitHub handle of the subscriber

slackChannel
string

The Slack channel where contract violations will be sent

Response

Contract subscription was successfully created

id
string<uuid>
required

The unique identifier of the subscription

dataContractId
string<uuid>
required

Unique identifier of the contract

userId
string<uuid>

The unique identifier of the user

email
string

The email address of the subscriber if provided

Pattern: ^[a-zA-Z0-9_.+-]+@[a-zA-Z0-9-]+\.[a-zA-Z0-9-.]+$
githubHandle
string

The GitHub handle of the subscriber if provided

slackChannel
string

The Slack channel where contract violations will be sent