Axiom Docs

PUT

notifiers

{id}

cURL

curl --request PUT \
  --url https://api.axiom.co/v2/notifiers/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Production Slack Alerts",
  "properties": {
    "customWebhook": {
      "body": "{\"alert\": \"{{.AlertName}}\", \"severity\": \"{{.Severity}}\", \"message\": \"{{.Message}}\"}",
      "url": "https://api.custom-service.com/alerts",
      "headers": {
        "Content-Type": "application/json",
        "X-API-Version": "1.0"
      },
      "secretHeaders": {
        "Authorization": "Bearer {{token}}"
      }
    },
    "discord": {
      "discordChannel": "123456789012345678",
      "discordToken": "Bot 123456789012345678"
    },
    "discordWebhook": {
      "discordWebhookUrl": "https://discord.com/api/webhooks/123456789012345678/XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
    },
    "email": {
      "emails": [
        "[email protected]",
        "[email protected]"
      ]
    },
    "microsoftTeams": {
      "microsoftTeamsUrl": "https://outlook.office.com/webhook/123456789/IncomingWebhook/..."
    },
    "opsgenie": {
      "apiKey": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
      "isEU": true
    },
    "pagerduty": {
      "routingKey": "1234567890abcdef1234567890abcdef",
      "token": "u+1234567890abcdef1234567890abcdef"
    },
    "slack": {
      "slackUrl": "https://hooks.slack.com/services/T00000000/B00000000/XXXXXXXXXXXXXXXXXXXXXXXX"
    },
    "webhook": {
      "url": "https://api.example.com/webhooks/alerts"
    }
  },
  "disabledUntil": "2024-03-20T15:00:00Z"
}
'

{
  "name": "Production Slack Alerts",
  "properties": {
    "customWebhook": {
      "body": "{\"alert\": \"{{.AlertName}}\", \"severity\": \"{{.Severity}}\", \"message\": \"{{.Message}}\"}",
      "url": "https://api.custom-service.com/alerts",
      "headers": {
        "Content-Type": "application/json",
        "X-API-Version": "1.0"
      },
      "secretHeaders": {
        "Authorization": "Bearer {{token}}"
      }
    },
    "discord": {
      "discordChannel": "123456789012345678",
      "discordToken": "Bot 123456789012345678"
    },
    "discordWebhook": {
      "discordWebhookUrl": "https://discord.com/api/webhooks/123456789012345678/XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
    },
    "email": {
      "emails": [
        "[email protected]",
        "[email protected]"
      ]
    },
    "microsoftTeams": {
      "microsoftTeamsUrl": "https://outlook.office.com/webhook/123456789/IncomingWebhook/..."
    },
    "opsgenie": {
      "apiKey": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
      "isEU": true
    },
    "pagerduty": {
      "routingKey": "1234567890abcdef1234567890abcdef",
      "token": "u+1234567890abcdef1234567890abcdef"
    },
    "slack": {
      "slackUrl": "https://hooks.slack.com/services/T00000000/B00000000/XXXXXXXXXXXXXXXXXXXXXXXX"
    },
    "webhook": {
      "url": "https://api.example.com/webhooks/alerts"
    }
  },
  "createdAt": "2024-01-15T10:30:00Z",
  "createdBy": "[email protected]",
  "disabledUntil": "2024-03-20T15:00:00Z",
  "id": "notify_slack_prod"
}

Authorizations

Authorization

string

header

required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

string

required

Body

application/json

Configuration for a notification channel. Notifiers can be configured for various services like:

Slack
Email
PagerDuty
OpsGenie
Discord
Microsoft Teams
Custom Webhooks

name

string

required

Human-readable name for the notifier

Example:

"Production Slack Alerts"

properties

object

required

Configuration options for different notification channels. Only one channel should be configured per notifier.

Show child attributes

properties.customWebhook

object

Configuration for custom webhook notifications with flexible headers and body template. Supports variable substitution in the body template using {{.Variable}} syntax.

Show child attributes

properties.customWebhook.body

string

required

Template for the webhook body, supports variable substitution

Example:

"{\"alert\": \"{{.AlertName}}\", \"severity\": \"{{.Severity}}\", \"message\": \"{{.Message}}\"}"

properties.customWebhook.url

string

required

Custom webhook endpoint URL

Example:

"https://api.custom-service.com/alerts"

properties.customWebhook.headers

object

HTTP headers to include in the request

Show child attributes

properties.customWebhook.headers.{key}

string

Example:

{
  "Content-Type": "application/json",
  "X-API-Version": "1.0"
}

properties.customWebhook.secretHeaders

object

Sensitive HTTP headers (tokens, keys) that should be masked in logs

Show child attributes

properties.customWebhook.secretHeaders.{key}

string

Example:

{ "Authorization": "Bearer {{token}}" }

properties.discord

object

Configuration for Discord notifications using bot token

Show child attributes

properties.discord.discordChannel

string

Discord channel ID to send notifications

Example:

"123456789012345678"

properties.discord.discordToken

string

Discord bot token for authentication

Example:

"Bot 123456789012345678"

properties.discordWebhook

object

Configuration for Discord notifications using webhooks

Show child attributes

properties.discordWebhook.discordWebhookUrl

string

Discord webhook URL

Example:

"https://discord.com/api/webhooks/123456789012345678/XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"

properties.email

object

Configuration for email notifications

Show child attributes

properties.email.emails

string[]

List of email addresses to receive notifications

Example:

["[email protected]", "[email protected]"]

properties.microsoftTeams

object

Configuration for Microsoft Teams notifications

Show child attributes

properties.microsoftTeams.microsoftTeamsUrl

string

Microsoft Teams webhook URL

Example:

"https://outlook.office.com/webhook/123456789/IncomingWebhook/..."

properties.opsgenie

object

Configuration for OpsGenie integration

Show child attributes

properties.opsgenie.apiKey

string

OpsGenie API key for authentication

Example:

"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"

properties.opsgenie.isEU

boolean

Whether to use EU region endpoints

Example:

true

properties.pagerduty

object

Configuration for PagerDuty integration

Show child attributes

properties.pagerduty.routingKey

string

PagerDuty integration key for routing alerts

Example:

"1234567890abcdef1234567890abcdef"

properties.pagerduty.token

string

PagerDuty API token for additional functionality

Example:

"u+1234567890abcdef1234567890abcdef"

properties.slack

object

Configuration for Slack notifications using incoming webhooks

Show child attributes

properties.slack.slackUrl

string

Slack incoming webhook URL

Example:

"https://hooks.slack.com/services/T00000000/B00000000/XXXXXXXXXXXXXXXXXXXXXXXX"

properties.webhook

object

Configuration for simple webhook notifications

Show child attributes

properties.webhook.url

string

Webhook endpoint URL

Example:

"https://api.example.com/webhooks/alerts"

disabledUntil

string

ISO timestamp until which the notifier is disabled (null if enabled)

Example:

"2024-03-20T15:00:00Z"

Response

200 - application/json

Notifier

Notifier configuration with its unique identifier

name

string

required

Human-readable name for the notifier

Example:

"Production Slack Alerts"

properties

object

required

Configuration options for different notification channels. Only one channel should be configured per notifier.

Show child attributes

properties.customWebhook

object

Configuration for custom webhook notifications with flexible headers and body template. Supports variable substitution in the body template using {{.Variable}} syntax.

Show child attributes

properties.customWebhook.body

string

required

Template for the webhook body, supports variable substitution

Example:

"{\"alert\": \"{{.AlertName}}\", \"severity\": \"{{.Severity}}\", \"message\": \"{{.Message}}\"}"

properties.customWebhook.url

string

required

Custom webhook endpoint URL

Example:

"https://api.custom-service.com/alerts"

properties.customWebhook.headers

object

HTTP headers to include in the request

Show child attributes

properties.customWebhook.headers.{key}

string

Example:

{
  "Content-Type": "application/json",
  "X-API-Version": "1.0"
}

properties.customWebhook.secretHeaders

object

Sensitive HTTP headers (tokens, keys) that should be masked in logs

Show child attributes

properties.customWebhook.secretHeaders.{key}

string

Example:

{ "Authorization": "Bearer {{token}}" }

properties.discord

object

Configuration for Discord notifications using bot token

Show child attributes

properties.discord.discordChannel

string

Discord channel ID to send notifications

Example:

"123456789012345678"

properties.discord.discordToken

string

Discord bot token for authentication

Example:

"Bot 123456789012345678"

properties.discordWebhook

object

Configuration for Discord notifications using webhooks

Show child attributes

properties.discordWebhook.discordWebhookUrl

string

Discord webhook URL

Example:

"https://discord.com/api/webhooks/123456789012345678/XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"

properties.email

object

Configuration for email notifications

Show child attributes

properties.email.emails

string[]

List of email addresses to receive notifications

Example:

["[email protected]", "[email protected]"]

properties.microsoftTeams

object

Configuration for Microsoft Teams notifications

Show child attributes

properties.microsoftTeams.microsoftTeamsUrl

string

Microsoft Teams webhook URL

Example:

"https://outlook.office.com/webhook/123456789/IncomingWebhook/..."

properties.opsgenie

object

Configuration for OpsGenie integration

Show child attributes

properties.opsgenie.apiKey

string

OpsGenie API key for authentication

Example:

"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"

properties.opsgenie.isEU

boolean

Whether to use EU region endpoints

Example:

true

properties.pagerduty

object

Configuration for PagerDuty integration

Show child attributes

properties.pagerduty.routingKey

string

PagerDuty integration key for routing alerts

Example:

"1234567890abcdef1234567890abcdef"

properties.pagerduty.token

string

PagerDuty API token for additional functionality

Example:

"u+1234567890abcdef1234567890abcdef"

properties.slack

object

Configuration for Slack notifications using incoming webhooks

Show child attributes

properties.slack.slackUrl

string

Slack incoming webhook URL

Example:

"https://hooks.slack.com/services/T00000000/B00000000/XXXXXXXXXXXXXXXXXXXXXXXX"

properties.webhook

object

Configuration for simple webhook notifications

Show child attributes

properties.webhook.url

string

Webhook endpoint URL

Example:

"https://api.example.com/webhooks/alerts"

createdAt

string<date-time>

Timestamp when the notifier was created

Example:

"2024-01-15T10:30:00Z"

createdBy

string

Email or ID of the user who created the notifier

Example:

"[email protected]"

disabledUntil

string

ISO timestamp until which the notifier is disabled (null if enabled)

Example:

"2024-03-20T15:00:00Z"

string

Unique identifier for the notifier

Example:

"notify_slack_prod"

Delete notifierDelete notifier

⌘I

cURL

curl --request PUT \
  --url https://api.axiom.co/v2/notifiers/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Production Slack Alerts",
  "properties": {
    "customWebhook": {
      "body": "{\"alert\": \"{{.AlertName}}\", \"severity\": \"{{.Severity}}\", \"message\": \"{{.Message}}\"}",
      "url": "https://api.custom-service.com/alerts",
      "headers": {
        "Content-Type": "application/json",
        "X-API-Version": "1.0"
      },
      "secretHeaders": {
        "Authorization": "Bearer {{token}}"
      }
    },
    "discord": {
      "discordChannel": "123456789012345678",
      "discordToken": "Bot 123456789012345678"
    },
    "discordWebhook": {
      "discordWebhookUrl": "https://discord.com/api/webhooks/123456789012345678/XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
    },
    "email": {
      "emails": [
        "[email protected]",
        "[email protected]"
      ]
    },
    "microsoftTeams": {
      "microsoftTeamsUrl": "https://outlook.office.com/webhook/123456789/IncomingWebhook/..."
    },
    "opsgenie": {
      "apiKey": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
      "isEU": true
    },
    "pagerduty": {
      "routingKey": "1234567890abcdef1234567890abcdef",
      "token": "u+1234567890abcdef1234567890abcdef"
    },
    "slack": {
      "slackUrl": "https://hooks.slack.com/services/T00000000/B00000000/XXXXXXXXXXXXXXXXXXXXXXXX"
    },
    "webhook": {
      "url": "https://api.example.com/webhooks/alerts"
    }
  },
  "disabledUntil": "2024-03-20T15:00:00Z"
}
'

{
  "name": "Production Slack Alerts",
  "properties": {
    "customWebhook": {
      "body": "{\"alert\": \"{{.AlertName}}\", \"severity\": \"{{.Severity}}\", \"message\": \"{{.Message}}\"}",
      "url": "https://api.custom-service.com/alerts",
      "headers": {
        "Content-Type": "application/json",
        "X-API-Version": "1.0"
      },
      "secretHeaders": {
        "Authorization": "Bearer {{token}}"
      }
    },
    "discord": {
      "discordChannel": "123456789012345678",
      "discordToken": "Bot 123456789012345678"
    },
    "discordWebhook": {
      "discordWebhookUrl": "https://discord.com/api/webhooks/123456789012345678/XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
    },
    "email": {
      "emails": [
        "[email protected]",
        "[email protected]"
      ]
    },
    "microsoftTeams": {
      "microsoftTeamsUrl": "https://outlook.office.com/webhook/123456789/IncomingWebhook/..."
    },
    "opsgenie": {
      "apiKey": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
      "isEU": true
    },
    "pagerduty": {
      "routingKey": "1234567890abcdef1234567890abcdef",
      "token": "u+1234567890abcdef1234567890abcdef"
    },
    "slack": {
      "slackUrl": "https://hooks.slack.com/services/T00000000/B00000000/XXXXXXXXXXXXXXXXXXXXXXXX"
    },
    "webhook": {
      "url": "https://api.example.com/webhooks/alerts"
    }
  },
  "createdAt": "2024-01-15T10:30:00Z",
  "createdBy": "[email protected]",
  "disabledUntil": "2024-03-20T15:00:00Z",
  "id": "notify_slack_prod"
}

Get started

Annotation endpoints

API token endpoints

Dataset endpoints

Edge endpoints

Map field endpoints

Monitor endpoints

Notifier endpoints

Organization endpoints

Role-Based Access Control endpoints

Saved queries endpoints

User endpoints

Views endpoints

Virtual fields endpoints

Update notifier

Authorizations

Path Parameters

Body

Response