Explore documentation
  1. Welcome to Uptime 👋
  2. Frequently Asked Questions
  3. Monitoring
    1. Get started with monitoring
    2. Working with monitors
    3. Customizing monitors
    4. Monitor types
  4. On-call scheduling and alerting
    1. Get started with on-call
    2. Sending alerts to Slack ↗
    3. Connecting external calendars
    4. Advanced on-call setup
  5. Incidents
    1. Working with incidents
    2. Create incidents manually
    3. Post mortems
    4. Incident silencing
    5. Incident metadata
  6. Status pages
    1. Get started with status pages
    2. Working with status pages
  7. Integrations
    1. Integrating with Better Stack
  8. Team and account management
    1. Team management
    2. Account settings
    3. Audit logs
    4. Migrating to pay as you go
  9. API
    1. Get started with API
  10. Monitors API
    1. Monitors
    2. Monitor groups
    3. Heartbeats
    4. Heartbeat groups
  11. On-call & Incidents API
    1. On-call calendar
    2. On-call calendar events
    3. Escalation policies
    4. Escalation policy groups
    5. Severities
    6. Severity groups
    7. Incidents
    8. Comments
  12. Integrations API
    1. New Relic Integrations
    2. Datadog Integrations
    3. AWS CloudWatch Integrations
    4. Azure Integrations
    5. Google Monitoring Integrations
    6. Grafana Integrations
    7. Prometheus Integrations
    8. Email integrations
    9. Incoming webhooks
    10. Slack Integrations
    11. Outgoing Webhook integrations
      1. List all Outgoing Webhook integrations GET
      2. Get a single Outgoing Webhook integration GET
      3. Create a Outgoing Webhook integration POST
      4. Update a Outgoing Webhook integration PATCH
      5. Delete a Outgoing Webhook integration DELETE
      6. Outgoing Webhook integration API response params
    12. Splunk On-Call integrations
    13. PagerDuty Integrations
  13. Status pages API
    1. Status pages
    2. Status page sections
    3. Status page resources
    4. Status page reports
    5. Status page report updates
  14. Other API
    1. Metadata

Create a Outgoing Webhook integration

Returns either a newly created Outgoing Webhook integration, or validation errors.

POST https://uptime.betterstack.com/api/v2/outgoing-webhooks

Headers

Authorization
required string

Bearer $TOKEN

Content_Type
string

application/json

Body parameters

team_name
string

Required if using global API token to specify the team which should own the resource.

name
string

The name of the Outgoing Webhook integration that you can see in the dashboard.

url
required string

The URL of the Outgoing Webhook integration.

trigger_type
required string

The type of trigger for the Outgoing Webhook integration. Possible values are on_call_change, incident_change and monitor_change.

on_incident_started
boolean

Whether to trigger the Outgoing Webhook integration when an incident starts. Only applicable if trigger_type is incident_change.

on_incident_acknowledged
boolean

Whether to trigger the Outgoing Webhook integration when an incident is acknowledged. Only applicable if trigger_type is incident_change.

on_incident_resolved
boolean

Whether to trigger the Outgoing Webhook integration when an incident is resolved. Only applicable if trigger_type is incident_change.

custom_webhook_template_attributes
object

Use this to specify the custom webhook template attributes. See below.

custom_webhook_template_attributes.http_method
string

The HTTP method to use when sending the webhook. Possible values are get, post, put, patch and head.

custom_webhook_template_attributes.auth_username
string

The username to use for basic authentication.

custom_webhook_template_attributes.auth_password
string

The password to use for basic authentication.

custom_webhook_template_attributes.headers_template
array

The headers to send with the webhook.

Each header is an object with `name` and `value` keys.
{
  "custom_webhook_template_attributes": {
    "headers_template": [
      { "name": "Content-Type", "value": "application/json" },
      { "name": "X-Custom-Header", "value": "Custom-Value" }
    ]
  }
}
custom_webhook_template_attributes.body_template
string|JSON

The body to send with the webhook. The value can be a stringified JSON or a JSON object.

Using JSON object
{
  "custom_webhook_template_attributes": {
    "body_template": {
      "data": {
        "id": "$INCIDENT_ID",
        "type": "incident",
        "attributes": {
          "name": "$NAME",
          "url": "$URL",
          "http_method": "$HTTP_METHOD",
          "screenshot_url": "$SCREENSHOT_URL"
        }
      }
    }
  }
}
Using stringified JSON
{
  "custom_webhook_template_attributes": {
    "body_template": "{\"data\":{\"id\":\"$INCIDENT_ID\",\"type\":\"incident\",\"attributes\":{\"name\":\"$NAME\",\"url\":\"$URL\",\"http_method\":\"$HTTP_METHOD\",\"screenshot_url\":\"$SCREENSHOT_URL\"}}}"
  }
}

When not specified, the default template is used. Each trigger_type has its own default template:

Default template for `on_call_change`
{
  "data":{
    "message": "$MESSAGE",
    "emails": $EMAILS_JSON_ARRAY,
    "calendar_id": $ON_CALL_CALENDAR_ID,
    "calendar_name": "$ON_CALL_CALENDAR_NAME",
    "primary_calendar": $DEFAULT_ON_CALL_CALENDAR
  }
}
Default template for `incident_change`
{
  "data": {
    "id": "$INCIDENT_ID",
    "type": "incident",
    "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"
    }
  }
}
Default template for `monitor_change`
{
  "data":{
    "id": "$MONITOR_ID",
    "type": "monitor",
    "attributes":{
      "url": "$URL",
      "pronounceable_name": "$PRONOUNCEABLE_NAME",
      "monitor_type": "$MONITOR_TYPE",
      "required_keyword": "$REQUIRED_KEYWORD",
      "verify_ssl": $VERIFY_SSL,
      "check_frequency": $CHECK_FREQUENCY,
      "call": $CALL,
      "sms": $SMS,
      "email": $EMAIL,
      "team_wait": "$TEAM_WAIT",
      "http_method": "$HTTP_METHOD",
      "request_timeout": "$REQUEST_TIMEOUT",
      "recovery_period": "$RECOVERY_PERIOD",
      "request_body": "$REQUEST_BODY",
      "paused_at": "$PAUSED_AT",
      "last_checked_at": "$LAST_CHECKED_AT"
    }
  }
}
201

Returns newly created Outgoing Webhook integration

Response body

{
  "data": {
    "id": "16",
    "type": "outgoing_webhook",
    "attributes": {
      "name": "test",
      "url": "https://example.com",
      "trigger_type": "on_call_change",
      "team_name": "My team"
    },
    "relationships": {
      "custom_webhook_template": {
        "data": null
      }
    }
  },
  "included": [

  ]
}

Example cURL

Example
curl -X "POST" "https://uptime.betterstack.com/api/v2/outgoing-webhooks/" \
     -H "Authorization: Bearer $TOKEN" \
     -H 'Content-Type: application/json; charset=utf-8' \
     -d $'{
  "name": "Test",
  "url": "https://example.com",
  "trigger_type": "on_call_change"
}'

Previous article

Get a single Outgoing Webhook integration

Next article

Update a Outgoing Webhook integration