Skip to main content
POST
Core - Create email notifier

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Create notifier request. project_id, display_name, and type are always required. The destination field required by type is captured in oneOf.

type
enum<string>
required

Required. Destination type. Use NOTIFIER_TYPE_EMAIL, NOTIFIER_TYPE_SLACK_WEBHOOK, or NOTIFIER_TYPE_WEBHOOK.

Available options:
NOTIFIER_TYPE_EMAIL
emails
string[]
required

Required when type is NOTIFIER_TYPE_EMAIL. Omit for other notifier types.

display_name
string
required

Required. Human-readable notifier name.

project_id
string

Optional. Workspace-scoped callers may set this to create a project-scoped notifier, or omit it for a workspace-wide notifier. Project-scoped API keys create in the API key's project.

metadata
object

Optional. Custom JSON metadata stored with the notifier.

incoming_webhook_url
string

Required when type is NOTIFIER_TYPE_SLACK_WEBHOOK. Omit for other notifier types.

webhook_url
string

Required when type is NOTIFIER_TYPE_WEBHOOK. Omit for other notifier types.

headers
object

Optional generic webhook headers. Each value may be a string or { "secret": true, "value": "..." }.

Response

200 - application/json

OK

notifier
Email notifier · object
required

Notifier resource. The destination field present on the resource depends on type and is captured in oneOf.