Monitoring Integrations API Reference

You can programmatically create third party monitoring integrations using the REST API.

Create integration

Endpoint:

POST /v3/integrations

Body parameters

Example request

{
  "pageId": "page123",
  "integrationType": "PINGDOM",
  "components": ["component1", "component2"]
}

Example response

{
  "integration": {
    "id": "int_abc",
    "monitoringTool": "PINGDOM"
  },
  "message": "Integration created successfully."
}

This endpoint accepts any monitoring tool listed in our MonitoringTool enum.

Update integration

Endpoint:

PUT /v3/integrations/:integration_id

Send any of the fields from the create endpoint, or provide new template data to customize incident creation and resolution.

Example request

{
  "label": "Pingdom Primary",
  "createTemplate": { "name": "New incident" },
  "resolveTemplate": { "name": "Incident resolved" }
}

Example response

{
  "integration": {
    "id": "int_abc",
    "label": "Pingdom Primary"
  }
}

Delete integration

Endpoint:

DELETE /v3/integrations/:integration_id

Example response

{}