Overview
API
Request a demo
API Documentation

Notification Service

The notification service is responsible for sending notifications to external systems. This includes emails, slack messages and webhooks.

Endpoints

Notifications

POST
/api/v1/internal/email/confirmation
Send a confirmation email.
POST
/api/v1/internal/email/password-reset
Send a password reset email.
POST
/api/v1/internal/notification
Send notifications for Inventory related events.
POST
/api/v1/internal/slack/notification
Send Slack notifications for events.
POST
/api/v1/internal/webhook/notification
Send webhook notifications for events.

Schemas

EmailConfirmationRequest

Description:
Request object for the Email Confirmation handler.
Type:
object
Field Type Description Example
confirmation_code
string
 The confirmation code for the new user.
email
string
 The target email address.
public_url
string
 The public URL for this Escape Kit installation.
username
string
 The username of the new user.

EmailPasswordResetRequest

Description:
Request object for the Email Password Reset handler.
Type:
object
Field Type Description Example
email
string
 The target email address.
password_reset_token
string
 The password reset token for the user.
public_url
string
 The public URL for this Escape Kit installation.
username
string
 The username of the new user.

Hook

Description:
Hook
Type:
object
Field Type Description Example
icon_emoji
string
 The icon to use when posting to Slack (not used!)
url
string
 The URL to POST to.
username
string
 The username to use when posting to Slack (not used!)

Hooks

Description:
Hooks
Type:
{
string
: Hook }

InventoryNotificationRequest

Description:
Request object for the Inventory Notification handler.
Type:
object
Field Type Description Example
downstream_hooks [ {
string
: Hook } ] 		The downstream hooks to trigger.
event
string
 The event type. At the moment only the NEW_UPLOAD type is supported.
project
string
 The project this event pertains to.
project_hooks {
string
: Hook } 		The project hooks to trigger.
release
string
 The release this event pertains to.
unit
string
 The unit/application this event pertains to.
unit_hooks {
string
: Hook } 		The unit hooks to trigger.
username
string
 The username this event pertains to.
version
string
 The version this event pertains to.

SlackNotificationRequest

Description:
Request object for the Slack Notification handler.
Type:
object
Field Type Description Example
data
object
 Webhook data
emoji
string
 Slack webhook emoji
url
string
 Slack webhook url
username
string
 Slack webhook username

WebhookNotificationRequest

Description:
Request object for the webhook Notification handler.
Type:
object
Field Type Description Example
data
object
 Webhook data
url
string
 Webhook url