GEgetorchestra
Incidents

Send an incident event

Changed on

Send an event from an external system, as a JSON object of at most 128 KiB, to be matched against the workspace's monitors. Resending the same body within five minutes returns the same eventId.

post/incidents/events

Request

  • Base URL
    https://app.getorchestra.io/api/engine/public
  • URL
    https://app.getorchestra.io/api/engine/public/incidents/events
  • Auth
    • HTTP bearer
    • or OAuth 2
      Authorization code: https://app.getorchestra.io/oauth/authorize
      Token URL: https://app.getorchestra.io/oauth/token scopes: orchestra:write

Headers

X-Orchestra-Account-Idstring uuid4 nullable

Act on this account rather than the one the credential resolves to. Omit it to use the credential's own account. An API key is issued to a single account, so it may only name that account; an OAuth token may name any account its grant covers.

Request body

object required

An event from an external system, as whatever JSON object that system emits.

No field is required or interpreted: monitors pick out the values they match and group on with jsonpath. The body must be an object because those paths are resolved against one.

Response

Successful Response

eventIdstring uuid required

Changes