Update notifier

PUT/v2/notifiers/{id}

Replaces a notifier's name, channel properties, and disabledUntil with the request body, so omitted fields are cleared. labelIds replaces assignments when supplied; [] clears them. Omitted or null labelIds preserves assignments on updates and creates an unlabeled resource on creation. IDs must belong to existing labels in your organization and are validated before saving.

Parameters

Property	Type	Location	Description
`id`	`string`Required	`path`	Notifier ID.

Body

Configuration for a notification channel. Notifiers can be configured for various services like: - Slack - Email - PagerDuty - OpsGenie - Discord - Microsoft Teams - Custom Webhooks - Cursor - Claude Code - Jira Service Management

application/json

Property	Type	Description
`createdAt`	`string<date-time>`	Timestamp when the notifier was created
`createdBy`	`string`	Email or ID of the user who created the notifier
`createdByAgent`	`boolean`	true when the MCP server created this notifier
`disabled`	`boolean`	Whether repeated delivery failures disabled the notifier. False when a user snoozed it with disabledUntil. Ignored on requests
`disabledUntil`	`string`	ISO timestamp until which the notifier is disabled (null if enabled)
`lastError`	`string`	The delivery error that disabled the notifier. Empty for email notifiers and when disabled is false. Ignored on requests
`name`	`string`Required	Human-readable name for the notifier
`properties`	`object`Required	Configuration options for different notification channels. Only one channel should be configured per notifier.
`amp`	`object`	Amp Orb webhook. The receiving plugin must accept {"text": "<monitor summary>"}.
`webhookUrl`	`string`Required	Secret HTTPS URL from the Amp plugin createWebhook registration. Returned encrypted on reads; submit it unchanged to retain it on updates.
`chatgptWorkspaceAgent`	`object`	Published ChatGPT Workspace Agent API channel. Axiom sends {"input": "<monitor summary>"}.
`token`	`string`Required	ChatGPT access token with the Workspace Agents scope
`triggerId`	`string`Required	API channel trigger ID beginning with agtch_
`claudeCode`	`object`	Claude Code routine. Axiom sends a fixed text body when the monitor fires.
`routineId`	`string`Required	Routine ID from a Claude Code API trigger
`token`	`string`Required	Bearer token for the routine
`cursor`	`object`	Cursor automation webhook. Axiom sends a fixed context body when the monitor fires.
`token`	`string`Required	Bearer token for the automation webhook
`webhookUrl`	`string`Required	Automation webhook URL from a Cursor automation
`customWebhook`	`object`	Configuration for custom webhook notifications with flexible headers and body template. Supports variable substitution in the body template using {{.Variable}} syntax.
`body`	`string`Required	Template for the webhook body, supports variable substitution
`headers`	`object`	HTTP headers to include in the request
`secretHeaders`	`object`	Sensitive HTTP headers (tokens, keys) that should be masked in logs
`url`	`string`Required	Custom webhook endpoint URL
`discord`	`object`	Configuration for Discord notifications using bot token
`discordChannel`	`string`	Discord channel ID to send notifications
`discordToken`	`string`	Discord bot token for authentication
`messageTemplate`	`object`	Go templates that replace the title and body of the notifier's default message. An empty field keeps the default. Variables include {{.Title}}, {{.Body}}, {{.Name}}, {{.Action}}, {{.Value}}, {{.Threshold}}, {{.Labels}}, {{.Groups}} and {{.MatchedEvent}}. If a template fails when a notification is sent, the default message is sent and the delivery records the error.
`body`	`string`	Template for the message body
`title`	`string`	Template for the message title
`discordWebhook`	`object`	Configuration for Discord notifications using webhooks
`discordWebhookUrl`	`string`	Discord webhook URL
`messageTemplate`	`object`	Go templates that replace the title and body of the notifier's default message. An empty field keeps the default. Variables include {{.Title}}, {{.Body}}, {{.Name}}, {{.Action}}, {{.Value}}, {{.Threshold}}, {{.Labels}}, {{.Groups}} and {{.MatchedEvent}}. If a template fails when a notification is sent, the default message is sent and the delivery records the error.
`body`	`string`	Template for the message body
`title`	`string`	Template for the message title
`email`	`object`	Configuration for email notifications
`emails`	`string[]`	List of email addresses to receive notifications
`messageTemplate`	`object`	Go templates that replace the title and body of the notifier's default message. An empty field keeps the default. Variables include {{.Title}}, {{.Body}}, {{.Name}}, {{.Action}}, {{.Value}}, {{.Threshold}}, {{.Labels}}, {{.Groups}} and {{.MatchedEvent}}. If a template fails when a notification is sent, the default message is sent and the delivery records the error.
`body`	`string`	Template for the message body
`title`	`string`	Template for the message title
`jiraServiceManagement`	`object`	Configuration for Jira Service Management Ops alerts using an API integration
`apiKey`	`string`Required	API key of the Jira Service Management API integration
`microsoftTeams`	`object`	Configuration for Microsoft Teams notifications
`messageTemplate`	`object`	Go templates that replace the title and body of the notifier's default message. An empty field keeps the default. Variables include {{.Title}}, {{.Body}}, {{.Name}}, {{.Action}}, {{.Value}}, {{.Threshold}}, {{.Labels}}, {{.Groups}} and {{.MatchedEvent}}. If a template fails when a notification is sent, the default message is sent and the delivery records the error.
`body`	`string`	Template for the message body
`title`	`string`	Template for the message title
`microsoftTeamsUrl`	`string`	Microsoft Teams webhook URL
`opsgenie`	`object`	Configuration for OpsGenie integration
`apiKey`	`string`	OpsGenie API key for authentication
`isEU`	`boolean`	Whether to use EU region endpoints
`pagerduty`	`object`	Configuration for PagerDuty integration
`routingKey`	`string`	PagerDuty integration key for routing alerts
`token`	`string`	PagerDuty API token for additional functionality
`slack`	`object`	Configuration for Slack notifications using incoming webhooks
`messageTemplate`	`object`	Go templates that replace the title and body of the notifier's default message. An empty field keeps the default. Variables include {{.Title}}, {{.Body}}, {{.Name}}, {{.Action}}, {{.Value}}, {{.Threshold}}, {{.Labels}}, {{.Groups}} and {{.MatchedEvent}}. If a template fails when a notification is sent, the default message is sent and the delivery records the error.
`body`	`string`	Template for the message body
`title`	`string`	Template for the message title
`slackUrl`	`string`	Slack incoming webhook URL
`webhook`	`object`	Configuration for simple webhook notifications
`url`	`string`	Webhook endpoint URL
`updatedAt`	`string<date-time>`	Timestamp when the notifier was last updated
`labelIds`	`string[]`	Existing label IDs; replaces assignments when supplied, clears with [], and preserves them when omitted or null.

Request

curl -X PUT 'https://api.axiom.co/v2/notifiers/ID' \
  -H 'Authorization: Bearer API_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{"createdAt":"2024-01-15T10:30:00Z","createdBy":"alice@example.com","createdByAgent":true,"disabled":true,"disabledUntil":"2024-03-20T15:00:00Z","lastError":"string","name":"Production Slack Alerts","properties":{"amp":{"webhookUrl":"string"},"chatgptWorkspaceAgent":{"token":"string","triggerId":"agtch_example"},"claudeCode":{"routineId":"trig_01ABCDEFGHJKLMNOPQRSTUVW","token":"string"},"cursor":{"token":"string","webhookUrl":"https://api2.cursor.sh/automations/webhook/00000000-0000-0000-0000-000000000000"},"customWebhook":{"body":"{\"alert\": \"{{.AlertName}}\", \"severity\": \"{{.Severity}}\", \"message\": \"{{.Message}}\"}","headers":{"Content-Type":"application/json","X-API-Version":"1.0"},"secretHeaders":{"Authorization":"Bearer {{token}}"},"url":"https://api.custom-service.com/alerts"},"discord":{"discordChannel":"123456789012345678","discordToken":"Bot 123456789012345678","messageTemplate":{"body":"Value {{.Value}} crossed {{.Threshold}}.{{range .Groups}}\n{{index .Values \"service\"}}: {{.Value}}{{end}}","title":"{{if eq .Action \"Open\"}}🔥{{else}}✅{{end}} {{.Name}}"}},"discordWebhook":{"discordWebhookUrl":"https://discord.com/api/webhooks/123456789012345678/XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX","messageTemplate":{"body":"Value {{.Value}} crossed {{.Threshold}}.{{range .Groups}}\n{{index .Values \"service\"}}: {{.Value}}{{end}}","title":"{{if eq .Action \"Open\"}}🔥{{else}}✅{{end}} {{.Name}}"}},"email":{"emails":["oncall@example.com","alerts@example.com"],"messageTemplate":{"body":"Value {{.Value}} crossed {{.Threshold}}.{{range .Groups}}\n{{index .Values \"service\"}}: {{.Value}}{{end}}","title":"{{if eq .Action \"Open\"}}🔥{{else}}✅{{end}} {{.Name}}"}},"jiraServiceManagement":{"apiKey":"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"},"microsoftTeams":{"messageTemplate":{"body":"Value {{.Value}} crossed {{.Threshold}}.{{range .Groups}}\n{{index .Values \"service\"}}: {{.Value}}{{end}}","title":"{{if eq .Action \"Open\"}}🔥{{else}}✅{{end}} {{.Name}}"},"microsoftTeamsUrl":"https://outlook.office.com/webhook/123456789/IncomingWebhook/..."},"opsgenie":{"apiKey":"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx","isEU":true},"pagerduty":{"routingKey":"1234567890abcdef1234567890abcdef","token":"u+1234567890abcdef1234567890abcdef"},"slack":{"messageTemplate":{"body":"Value {{.Value}} crossed {{.Threshold}}.{{range .Groups}}\n{{index .Values \"service\"}}: {{.Value}}{{end}}","title":"{{if eq .Action \"Open\"}}🔥{{else}}✅{{end}} {{.Name}}"},"slackUrl":"https://hooks.slack.com/services/T00000000/B00000000/XXXXXXXXXXXXXXXXXXXXXXXX"},"webhook":{"url":"https://api.example.com/webhooks/alerts"}},"updatedAt":"2024-01-15T11:00:00Z","labelIds":["string"]}'

Try itRun this request against your Axiom organization

Credentials stay in this browser tab and are only sent to Axiom when you run the request.

API token Requiredid pathRequiredRequest body application/json

{
  "createdAt": "2024-01-15T10:30:00Z",
  "createdBy": "alice@example.com",
  "createdByAgent": true,
  "disabled": true,
  "disabledUntil": "2024-03-20T15:00:00Z",
  "lastError": "string",
  "name": "Production Slack Alerts",
  "properties": {
    "amp": {
      "webhookUrl": "string"
    },
    "chatgptWorkspaceAgent": {
      "token": "string",
      "triggerId": "agtch_example"
    },
    "claudeCode": {
      "routineId": "trig_01ABCDEFGHJKLMNOPQRSTUVW",
      "token": "string"
    },
    "cursor": {
      "token": "string",
      "webhookUrl": "https://api2.cursor.sh/automations/webhook/00000000-0000-0000-0000-000000000000"
    },
    "customWebhook": {
      "body": "{\"alert\": \"{{.AlertName}}\", \"severity\": \"{{.Severity}}\", \"message\": \"{{.Message}}\"}",
      "headers": {
        "Content-Type": "application/json",
        "X-API-Version": "1.0"
      },
      "secretHeaders": {
        "Authorization": "Bearer {{token}}"
      },
      "url": "https://api.custom-service.com/alerts"
    },
    "discord": {
      "discordChannel": "123456789012345678",
      "discordToken": "Bot 123456789012345678",
      "messageTemplate": {
        "body": "Value {{.Value}} crossed {{.Threshold}}.{{range .Groups}}\n{{index .Values \"service\"}}: {{.Value}}{{end}}",
        "title": "{{if eq .Action \"Open\"}}🔥{{else}}✅{{end}} {{.Name}}"
      }
    },
    "discordWebhook": {
      "discordWebhookUrl": "https://discord.com/api/webhooks/123456789012345678/XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
      "messageTemplate": {
        "body": "Value {{.Value}} crossed {{.Threshold}}.{{range .Groups}}\n{{index .Values \"service\"}}: {{.Value}}{{end}}",
        "title": "{{if eq .Action \"Open\"}}🔥{{else}}✅{{end}} {{.Name}}"
      }
    },
    "email": {
      "emails": [
        "oncall@example.com",
        "alerts@example.com"
      ],
      "messageTemplate": {
        "body": "Value {{.Value}} crossed {{.Threshold}}.{{range .Groups}}\n{{index .Values \"service\"}}: {{.Value}}{{end}}",
        "title": "{{if eq .Action \"Open\"}}🔥{{else}}✅{{end}} {{.Name}}"
      }
    },
    "jiraServiceManagement": {
      "apiKey": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
    },
    "microsoftTeams": {
      "messageTemplate": {
        "body": "Value {{.Value}} crossed {{.Threshold}}.{{range .Groups}}\n{{index .Values \"service\"}}: {{.Value}}{{end}}",
        "title": "{{if eq .Action \"Open\"}}🔥{{else}}✅{{end}} {{.Name}}"
      },
      "microsoftTeamsUrl": "https://outlook.office.com/webhook/123456789/IncomingWebhook/..."
    },
    "opsgenie": {
      "apiKey": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
      "isEU": true
    },
    "pagerduty": {
      "routingKey": "1234567890abcdef1234567890abcdef",
      "token": "u+1234567890abcdef1234567890abcdef"
    },
    "slack": {
      "messageTemplate": {
        "body": "Value {{.Value}} crossed {{.Threshold}}.{{range .Groups}}\n{{index .Values \"service\"}}: {{.Value}}{{end}}",
        "title": "{{if eq .Action \"Open\"}}🔥{{else}}✅{{end}} {{.Name}}"
      },
      "slackUrl": "https://hooks.slack.com/services/T00000000/B00000000/XXXXXXXXXXXXXXXXXXXXXXXX"
    },
    "webhook": {
      "url": "https://api.example.com/webhooks/alerts"
    }
  },
  "updatedAt": "2024-01-15T11:00:00Z",
  "labelIds": [
    "string"
  ]
}

Response

200Updated notifier.

application/json

400Bad Request

404Not Found

Property	Type	Description
`createdAt`	`string<date-time>`	Timestamp when the notifier was created
`createdBy`	`string`	Email or ID of the user who created the notifier
`createdByAgent`	`boolean`	true when the MCP server created this notifier
`disabled`	`boolean`	Whether repeated delivery failures disabled the notifier. False when a user snoozed it with disabledUntil. Ignored on requests
`disabledUntil`	`string`	ISO timestamp until which the notifier is disabled (null if enabled)
`lastError`	`string`	The delivery error that disabled the notifier. Empty for email notifiers and when disabled is false. Ignored on requests
`name`	`string`Required	Human-readable name for the notifier
`properties`	`object`Required	Configuration options for different notification channels. Only one channel should be configured per notifier.
`amp`	`object`	Amp Orb webhook. The receiving plugin must accept {"text": "<monitor summary>"}.
`webhookUrl`	`string`Required	Secret HTTPS URL from the Amp plugin createWebhook registration. Returned encrypted on reads; submit it unchanged to retain it on updates.
`chatgptWorkspaceAgent`	`object`	Published ChatGPT Workspace Agent API channel. Axiom sends {"input": "<monitor summary>"}.
`token`	`string`Required	ChatGPT access token with the Workspace Agents scope
`triggerId`	`string`Required	API channel trigger ID beginning with agtch_
`claudeCode`	`object`	Claude Code routine. Axiom sends a fixed text body when the monitor fires.
`routineId`	`string`Required	Routine ID from a Claude Code API trigger
`token`	`string`Required	Bearer token for the routine
`cursor`	`object`	Cursor automation webhook. Axiom sends a fixed context body when the monitor fires.
`token`	`string`Required	Bearer token for the automation webhook
`webhookUrl`	`string`Required	Automation webhook URL from a Cursor automation
`customWebhook`	`object`	Configuration for custom webhook notifications with flexible headers and body template. Supports variable substitution in the body template using {{.Variable}} syntax.
`body`	`string`Required	Template for the webhook body, supports variable substitution
`headers`	`object`	HTTP headers to include in the request
`secretHeaders`	`object`	Sensitive HTTP headers (tokens, keys) that should be masked in logs
`url`	`string`Required	Custom webhook endpoint URL
`discord`	`object`	Configuration for Discord notifications using bot token
`discordChannel`	`string`	Discord channel ID to send notifications
`discordToken`	`string`	Discord bot token for authentication
`messageTemplate`	`object`	Go templates that replace the title and body of the notifier's default message. An empty field keeps the default. Variables include {{.Title}}, {{.Body}}, {{.Name}}, {{.Action}}, {{.Value}}, {{.Threshold}}, {{.Labels}}, {{.Groups}} and {{.MatchedEvent}}. If a template fails when a notification is sent, the default message is sent and the delivery records the error.
`body`	`string`	Template for the message body
`title`	`string`	Template for the message title
`discordWebhook`	`object`	Configuration for Discord notifications using webhooks
`discordWebhookUrl`	`string`	Discord webhook URL
`messageTemplate`	`object`	Go templates that replace the title and body of the notifier's default message. An empty field keeps the default. Variables include {{.Title}}, {{.Body}}, {{.Name}}, {{.Action}}, {{.Value}}, {{.Threshold}}, {{.Labels}}, {{.Groups}} and {{.MatchedEvent}}. If a template fails when a notification is sent, the default message is sent and the delivery records the error.
`body`	`string`	Template for the message body
`title`	`string`	Template for the message title
`email`	`object`	Configuration for email notifications
`emails`	`string[]`	List of email addresses to receive notifications
`messageTemplate`	`object`	Go templates that replace the title and body of the notifier's default message. An empty field keeps the default. Variables include {{.Title}}, {{.Body}}, {{.Name}}, {{.Action}}, {{.Value}}, {{.Threshold}}, {{.Labels}}, {{.Groups}} and {{.MatchedEvent}}. If a template fails when a notification is sent, the default message is sent and the delivery records the error.
`body`	`string`	Template for the message body
`title`	`string`	Template for the message title
`jiraServiceManagement`	`object`	Configuration for Jira Service Management Ops alerts using an API integration
`apiKey`	`string`Required	API key of the Jira Service Management API integration
`microsoftTeams`	`object`	Configuration for Microsoft Teams notifications
`messageTemplate`	`object`	Go templates that replace the title and body of the notifier's default message. An empty field keeps the default. Variables include {{.Title}}, {{.Body}}, {{.Name}}, {{.Action}}, {{.Value}}, {{.Threshold}}, {{.Labels}}, {{.Groups}} and {{.MatchedEvent}}. If a template fails when a notification is sent, the default message is sent and the delivery records the error.
`body`	`string`	Template for the message body
`title`	`string`	Template for the message title
`microsoftTeamsUrl`	`string`	Microsoft Teams webhook URL
`opsgenie`	`object`	Configuration for OpsGenie integration
`apiKey`	`string`	OpsGenie API key for authentication
`isEU`	`boolean`	Whether to use EU region endpoints
`pagerduty`	`object`	Configuration for PagerDuty integration
`routingKey`	`string`	PagerDuty integration key for routing alerts
`token`	`string`	PagerDuty API token for additional functionality
`slack`	`object`	Configuration for Slack notifications using incoming webhooks
`messageTemplate`	`object`	Go templates that replace the title and body of the notifier's default message. An empty field keeps the default. Variables include {{.Title}}, {{.Body}}, {{.Name}}, {{.Action}}, {{.Value}}, {{.Threshold}}, {{.Labels}}, {{.Groups}} and {{.MatchedEvent}}. If a template fails when a notification is sent, the default message is sent and the delivery records the error.
`body`	`string`	Template for the message body
`title`	`string`	Template for the message title
`slackUrl`	`string`	Slack incoming webhook URL
`webhook`	`object`	Configuration for simple webhook notifications
`url`	`string`	Webhook endpoint URL
`updatedAt`	`string<date-time>`	Timestamp when the notifier was last updated
`id`	`string`	Unique identifier for the notifier
`labelIds`	`string[]`Required	IDs of labels assigned to this notifier.
`labelNames`	`string[]`Required	Names of assigned labels, including with exclude=labels; [] when unassigned.
`labels`	`object[]`	Resolved labels assigned to this notifier.
`color`	`object`Required
`name`	`string`Required
`type`	`string`Required
`description`	`string`
`id`	`string`Required
`name`	`string`Required