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

Outgoing Webhook integration API response params

Response body parameters

Namespace data

Parameter Type Value
id String The ID of the Outgoing Webhook integration. String representation of a number.
type String outgoing_webhook
attributes Object Attributes object. Contains all the Outgoing Webhook integration attributes. See below.
attributes.name String Name of the Outgoing Webhook integration.
attributes.url String The Outgoing Webhook URL to which to post webhooks to.
attributes.team_name String The team this integration belongs to.
attributes.trigger_type String The type of trigger for the Outgoing Webhook integration. Possible values are on_call_change, incident_change and monitor_change
attributes.on_incident_started Boolean Whether to trigger the Outgoing Webhook integration when an incident starts. Only applicable if trigger_type is incident_change.
attributes.on_incident_acknowledged Boolean Whether to trigger the Outgoing Webhook integration when an incident is acknowledged. Only applicable if trigger_type is incident_change.
attributes.on_incident_resolved Boolean Whether to trigger the Outgoing Webhook integration when an incident is resolved. Only applicable if trigger_type is incident_change.

Namespace relationships

Parameter Type Value
custom_webhook_template Object The custom webhook template associated with the Outgoing Webhook integration. See below.
custom_webhook_template.data.id String The ID of the custom webhook template.
custom_webhook_template.data.type String custom_webhook_template

Namespace included

Parameter Type Value
id String The ID of the custom webhook template.
type String custom_webhook_template
attributes Object Attributes object. Contains all the custom webhook template attributes. See below.
attributes.http_method String The HTTP method to use when sending the webhook.
attributes.auth_username String The username to use for basic authentication.
attributes.auth_password String The password to use for basic authentication.
attributes.headers_template Headers The headers to send with the webhook.
attributes.body_template String The body to send with the webhook.

Headers

Parameter Type Value
name String The name of the header.
value String The value of the header.

Previous article

Delete a Outgoing Webhook integration

Next article

List all Splunk On-Call integrations