Explore documentation
  1. Welcome to Incidents 👋
  2. Frequently Asked Questions
  3. On-call scheduling and alerting
    1. Get started
    2. Slack and other integrations ↗
    3. Tag on-call in Slack
    4. Mobile apps ↗
    5. Connecting external calendars
    6. Advanced guide
  4. Incident management
    1. Get started
    2. AI SRE investigations
    3. Post mortems
    4. Metadata & Catalog
    5. Screening alerts
    6. Reporting ↗
  5. Monitoring
    1. Get started
    2. Working with monitors
    3. Customizing monitors
    4. Monitor types
  6. Status pages
    1. Get started
    2. Advanced guide
  7. Incidents API
    1. Getting an API token
    2. Pagination
    3. Monitors
    4. Heartbeats
    5. On-call & incidents
    6. Status pages
    7. Metadata
    8. Integrations
      1. New Relic
      2. Datadog
      3. AWS CloudWatch
      4. Amazon SNS
      5. Microsoft Azure
      6. Google Monitoring
      7. Grafana
      8. Elastic
      9. Prometheus
      10. E-mail
      11. Incoming webhooks
      12. Atlassian Jira
      13. Slack
      14. Outgoing webhooks
        1. List outgoing webhooks GET
        2. Get outgoing webhook GET
        3. Create outgoing webhook POST
        4. Update outgoing webhook PATCH
        5. Remove outgoing webhook DELETE
      15. Outgoing e‑mails
      16. Splunk On-Call
      17. PagerDuty
      18. Catalog
    9. Team members
    10. Organization roles
    11. Usage
    12. Reporting

Get outgoing webhook

Returns a single Outgoing Webhook integration by ID.

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

URL parameters

outgoing_webhook_id
required string

The ID of the Outgoing Webhook integration you want to get.

Headers

Authorization
required string

Bearer $TOKEN

200

Returns a single Outgoing Webhook integration.

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
      }
    }
  },
  "included": []
}

Response attributes

id
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.

Example cURL

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


Previous article

List outgoing webhooks

Next article

Create outgoing webhook