HOhoneybadger
Integrations

Create an integration

Creates a notification integration. type picks the integration, and config holds its settings, listed per type in Integration types. An OAuth integration (Slack, GitHub, Linear and the like) sends nothing until someone connects it in the web UI at its links.web.

post/projects/{project_id}/integrations

Request

Path parameters

project_idstring required
Example:Xk9mZp

Project ID

Request body

activeboolean

Whether to use the integration. An OAuth integration that's active sends nothing until someone connects it in the web UI at links.web.

eventsIntegrationEvent[] nullable

Events this integration notifies on. On create, defaults to the type's default events. Null resets it to the type's defaults. A set; order is ignored and duplicates are dropped. up and down need uptime monitoring, rate_exceeded escalation, and volume_spike anomaly detection on the plan; the defaults leave them out on plans without them.

rate'min' | 'hour' | 'wday' | 'week'

Period the rate_exceeded threshold counts over: min a minute, hour an hour, wday a day (24 hours, not a weekday), week a week.

thresholdinteger nullable

Number of occurrences before rate_exceeded fires. Null resets it to 100.

notification_limitinteger nullable

Maximum notifications in a 10-minute window before flood control. Null removes the limit.

site_idsstring[] nullable

Sites whose up and down events this integration receives. null follows every site in the project, including ones added later; a create that leaves it out does the same. [] follows none, and a list follows just those sites. A set; order is ignored and duplicates are dropped.

check_in_idsstring[] nullable

Check-ins whose events this integration receives. null follows every check-in in the project, including ones added later; a create that leaves it out does the same. [] follows none, and a list follows just those check-ins. A set; order is ignored and duplicates are dropped.

alarm_alert_idsstring[] nullable

IDs of alarms whose alert events this integration receives. Null or empty clears it. A set; order is ignored and duplicates are dropped.

alarm_ok_idsstring[] nullable

IDs of alarms whose recovery events this integration receives. Null or empty clears it. A set; order is ignored and duplicates are dropped.

excluded_environmentsstring[] nullable

Errors from these environments never notify through this integration. Takes precedence over included_environments. An environment can be excluded before it first reports. Null or empty clears it. Changing it requires environment settings on the plan. A set; order is ignored and duplicates are dropped.

included_environmentsstring[] nullable

When non-empty, only errors from these environments notify through this integration, including environments that haven't reported yet. Empty means every environment not excluded. Null or empty clears it. Changing it requires environment settings on the plan. A set; order is ignored and duplicates are dropped.

type'CampfireV3' | 'Datadog' | 'DiscordWebhook' | 'Github' | 'Gitlab' | 'Bitbucket' | 'Asana' | 'Jira' | 'JiraCloud' | 'OpsGenieV2' | 'Redmine' | 'PagerDutyV2' | 'Sprintly' | 'Trello' | 'Linear' | 'Slack' | 'Mattermost' | 'GoogleHangoutsChat' | 'VictorOps' | 'WebHook' | 'Email' | 'Intercom' | 'AlertOps' | 'MicrosoftTeamsV2' | 'ShortcutV2' | 'PagerTree' | 'Instatus' | 'ClickUp' | 'ClickUpChat' | 'Ilert' | 'Zulip' | 'IncidentIo' | 'Rootly' | 'Backlog' required

Integration type. Each type's settings are listed in Integration types, and in its IntegrationConfig<Type> schema.

configobject

The type's settings, listed per type in Integration types.

Example request

{
  "type": "WebHook",
  "events": [
    "occurred",
    "resolved"
  ],
  "config": {
    "url": "https://example.com/hook"
  }
}

Response

Created

Example response

{
  "data": {
    "id": "Ch9wLp",
    "project_id": "Xk9mZp",
    "type": "Slack",
    "events": [
      "occurred",
      "resolved",
      "assigned"
    ],
    "excluded_environments": [
      "development"
    ],
    "included_environments": [],
    "filters": [
      {
        "event": "occurred",
        "query": "environment:production"
      }
    ],
    "alarm_alert_ids": [],
    "alarm_ok_ids": [],
    "threshold": 100,
    "error_reason": "The webhook URL returned 410 Gone",
    "links": {
      "web": "https://app.honeybadger.io/projects/Xk9mZp"
    }
  },
  "meta": {
    "request_id": "6f1c2b0e-8d4a-4f6e-9b2a-3c5d7e9f1a2b"
  }
}

Changes

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