Integrations

Create an integration

A webhook destination for one channel. Slack, Discord and Teams each get the payload shape their incoming webhooks expect; webhook receives a JSON event (ssl.alert, domain.alert, http.alert, dns.alert, keyword.alert, content.alert, port.alert, or the same with .test). Prove the URL with the test endpoint before relying on it.

post/v1/integrations

Request

  • Base URL: https://api.upcheck.so
  • URL: https://api.upcheck.so/v1/integrations
  • Auth: HTTP bearer

Request body

channel'slack' | 'discord' | 'teams' | 'webhook' required

Where an integration delivers. Email needs no integration; rules address recipients directly.

labelstring required
urlstring uri required

The incoming-webhook URL the channel gave you.

enabledboolean

Example request

{
  "label": "#ops",
  "url": "https://hooks.slack.com/services/..."
}

Response

Created.

idstring required

Opaque identifier.

organizationIdstring required

Opaque identifier.

channel'email' | 'slack' | 'discord' | 'teams' | 'webhook' required
labelstring required
urlstring nullable required
enabledboolean required
createdAtnumber required

Example response

{
  "id": "9b1d...",
  "organizationId": "9b1d..."
}

Changes

No recorded changes to this operation across all 1 revision of this API.