Skip to main content
POST
Create an integration

Supported apps

Only the following apps can be created through the API, each with its own settings:
The SMS integration requires a Scale plan subscription.

Why some apps are not supported

Some integrations need a step that can’t be done with an API request, so they can only be created from the control panel:
  • Slack and Discord: You need to sign in to Slack or Discord and approve the Phare app in your browser.
  • Telegram: The Phare bot is connected to your chat by opening a link or scanning a QR code on your device.
Requests for these apps return a 403 error. Once created in the control panel, they can still be listed, fetched, deleted, and used in alert rules through the API.

Authorizations

Authorization
string
header
required

Use a user token to access authenticated routes. The token must be specified in the Authorization HTTP header with the following format 'Authorization: Bearer '.

Headers

X-Phare-Project-Id
integer

A project header is required when using an organization-scoped API key.

Example:

1

X-Phare-Project-Slug
string

A project header is required when using an organization-scoped API key.

Example:

"luminous-guiding-tower"

Path Parameters

app
enum<string>
required

The app key

Available options:
sms,
email,
ilert,
ntfy,
outgoing_webhook,
pushover

Body

application/json

Integration request

name
string
required

Integration name

Required string length: 2 - 50
Example:

"DevOps Team"

settings
Empty · object

Settings specific to the integration app

Response

Success, integration created

name
string
required

Integration name

Required string length: 2 - 50
Example:

"DevOps Team"

id
integer

Integration ID

Example:

1

app
enum<string>
Available options:
sms,
discord,
email,
ilert,
ntfy,
outgoing_webhook,
pushover,
slack,
telegram
settings
Empty · object

Settings specific to the integration app

paused
boolean

Integration paused status

Example:

false

created_at
string<date-time>

Date of creation for the entity

updated_at
string<date-time>

Date of last update for the entity

Last modified on October 11, 2026