Explore documentation

List all Outgoing Webhook integrations

Returns a list of all your Outgoing Webhook integrations. This endpoint supports pagination.

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

Headers

Authorization
required string
200

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
        }
      }
    },
    {
      "id": "17",
      "type": "outgoing_webhook",
      "attributes": {
        "name": "test with custom template",
        "url": "https://example.com",
        "trigger_type": "incident_change",
        "team_name": "My team",
        "on_incident_started": true,
        "on_incident_acknowledged": false,
        "on_incident_resolved": true
      },
      "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://uptime.betterstack.test/api/v2/outgoing-webhooks?page=1",
    "last": "https://uptime.betterstack.test/api/v2/outgoing-webhooks?page=1",
    "prev": null,
    "next": null
  }
}

Example cURL

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