List outgoing webhooks

Returns a list of all your Outgoing Webhook integrations.

GET https://incidents.betterstack.com/api/v2/outgoing-webhooks

Query parameters

team_name

string

Filter outgoing webhooks belonging to a specified team when using global API token.

page

integer

The page number to return, starting with 1.

per_page

integer

Number of results per page. Defaults to 50, maximum 250.

Headers

Authorization

required string

Bearer $TOKEN

200

Returns a list of existing Outgoing Webhook integrations.

Response body

{
  "data": [
    {
      "id": "16",
      "type": "outgoing_webhook",
      "attributes": {
        "name": "test",
        "url": "https://example.com",
        "trigger_type": "on_call_change",
        "metadata_api_version": "v3",
        "team_name": "My team"
      },
      "relationships": {
        "custom_webhook_template": {
          "data": null
        }
      }
    },
    {
      "id": "17",
      "type": "outgoing_webhook",
      "attributes": {
        "name": "test with custom template",
        "url": "https://example.com",
        "trigger_type": "incident_change",
        "metadata_api_version": "v3",
        "notify_alongside_primary_responder": true,
        "team_name": "My team",
        "on_incident_started": true,
        "on_incident_acknowledged": false,
        "on_incident_resolved": true,
        "on_incident_reopened": true,
        "on_incident_comment": false
      },
      "relationships": {
        "custom_webhook_template": {
          "data": {
            "id": "18",
            "type": "custom_webhook_template"
          }
        }
      }
    }
  ],
  "included": [
    {
      "id": "18",
      "type": "custom_webhook_template",
      "attributes": {
        "http_method": "post",
        "headers_template": [
          {
            "name": "Content-Type",
            "value": "application/json"
          },
          {
            "name": "X-My-Header",
            "value": "my-value"
          }
        ],
        "body_template": "{\"data\":{\"id\":\"$INCIDENT_ID\",\"type\":\"incident\",\"hello\":\"world\",\"attributes\":{\"name\":\"$NAME\",\"url\":\"$URL\",\"http_method\":\"$HTTP_METHOD\",\"cause\":\"$CAUSE\",\"started_at\":\"$STARTED_AT\",\"acknowledged_at\":\"$ACKNOWLEDGED_AT\",\"resolved_at\":\"$RESOLVED_AT\",\"response_content\":\"$RESPONSE_CONTENT\",\"response_url\":\"$RESPONSE_URL\",\"screenshot_url\":\"$SCREENSHOT_URL\"}}}",
        "auth_username": "user",
        "auth_password": "password"
      }
    }
  ],
  "pagination": {
    "first": "https://incidents.betterstack.com/api/v2/outgoing-webhooks?page=1",
    "last": "https://incidents.betterstack.com/api/v2/outgoing-webhooks?page=1",
    "prev": null,
    "next": null
  }
}

Response attributes

string

The ID of the Outgoing Webhook integration.

type

string

Always outgoing_webhook.

attributes.name

string or null

The name of the Outgoing Webhook integration shown in the dashboard.

attributes.url

string

The URL the webhooks are sent to.

attributes.trigger_type

string

What triggers the webhook: on_call_change, incident_change, or monitor_change.

attributes.metadata_api_version

string

How the $METADATA variables in the URL and body template render, v3 or v2, as described in metadata variables.

attributes.notify_alongside_primary_responder

boolean

Whether to notify this integration alongside the primary responder when no escalation policy is configured. Returned only when trigger_type is incident_change.

attributes.team_name

string

The team this integration belongs to.

attributes.on_incident_started

boolean

Whether the webhook is sent when an incident starts. Returned only when trigger_type is incident_change.

attributes.on_incident_acknowledged

boolean

Whether the webhook is sent when an incident is acknowledged. Returned only when trigger_type is incident_change.

attributes.on_incident_resolved

boolean

Whether the webhook is sent when an incident is resolved. Returned only when trigger_type is incident_change.

attributes.on_incident_reopened

boolean

Whether the webhook is sent when an incident is reopened. Returned only when trigger_type is incident_change.

attributes.on_incident_comment

boolean

Whether the webhook is sent when a comment is added to an incident. Returned only when trigger_type is incident_change.

relationships.custom_webhook_template.data

object or null

The custom webhook template of this integration, or null when none is set.

relationships.custom_webhook_template.data.id

string

The ID of the custom webhook template.

relationships.custom_webhook_template.data.type

string

Always custom_webhook_template.

included

array

The custom webhook templates referenced in relationships.

included[].id

string

The ID of the custom webhook template.

included[].type

string

Always custom_webhook_template.

included[].attributes.http_method

string

The HTTP method used to send the webhook: get, post, put, patch, head, or options.

included[].attributes.headers_template

array or null

The headers sent with the webhook, as objects with name and value keys.

included[].attributes.body_template

string or null

The body sent with the webhook, or null for the default body of the trigger_type.

included[].attributes.auth_username

string or null

The username for basic authentication.

included[].attributes.auth_password

string or null

The password for basic authentication.

pagination.first

string

The URL of the first page. Read more about pagination.

pagination.last

string

The URL of the last page.

pagination.prev

string or null

The URL of the previous page, or null on the first page.

pagination.next

string or null

The URL of the next page, or null on the last page.

Example cURL

Example

Copied!

curl --request GET \
  --url https://incidents.betterstack.com/api/v2/outgoing-webhooks \
  --header "Authorization: Bearer $TOKEN"

Update Slack integration

Get outgoing webhook

Explore documentation

List outgoing webhooks

Example cURL

Please accept cookies