signal-incident

List signal incidents

List the Signal Incidents belonging to the partner the API key belongs to. A Signal Incident is raised when a conversation pages someone, and stays open until an agent resolves it. An incident nobody has closed yet is reported with status: "pending"; filter on that value to see only open incidents. Supports pagination (limit, offset), filters (a URL-encoded JSON array of { attribute, operator, value } conditions) and sort; newest first by default. Notification contact details are never returned. Requires the signalIncident:read scope.

GET

signal-incident

list

curl --request GET \
  --url https://connect.provisionapp.io/v1/signal-incident/list \
  --header 'x-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://connect.provisionapp.io/v1/signal-incident/list', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "conversationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "status": "pending",
      "urgency": "life_safety",
      "notificationTargetType": "partner",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "resolvedAt": "2023-11-07T05:31:56Z",
      "resolverId": "ovuid-2b6d4d8e-9f1a-4b2c-8d4e-5f6011223344"
    }
  ],
  "meta": {
    "total": 123,
    "limit": 123,
    "offset": 123
  }
}

{
  "error": {
    "code": "NOT_FOUND",
    "message": "<string>"
  }
}

{
  "error": {
    "code": "NOT_FOUND",
    "message": "<string>"
  }
}

{
  "error": {
    "code": "NOT_FOUND",
    "message": "<string>"
  }
}

{
  "error": {
    "code": "NOT_FOUND",
    "message": "<string>"
  }
}

{
  "error": {
    "code": "NOT_FOUND",
    "message": "<string>"
  }
}

{
  "error": {
    "code": "NOT_FOUND",
    "message": "<string>"
  }
}

Authorizations

x-api-key

string

header

required

Send the API key in the x-api-key header.

Query Parameters

limit

integer

default:20

Required range: 1 <= x <= 100

offset

integer | null

default:0

Required range: x >= 0

string

include

string

This endpoint does not support expanding related resources; any value is rejected.

filters

string

A URL-encoded JSON array of filter conditions, all AND-ed together. Each condition is { "attribute", "operator", "value", "valueType"? }. Allowed attributes: id, conversationId, status, urgency, notificationTargetType, resolverId, createdAt, resolvedAt, updatedAt. Allowed operators: =, !=, in, not_in, ilike, not_ilike, <, <=, >, >=, is_null, is_not_null. value is always a string; set valueType (one of boolean, number, number[], string, string[]) to coerce it — e.g. "boolean" for a true/false attribute or "string[]" for the in operator.

sort

string

Comma-separated list of fields to sort by, applied in order; prefix a field with - for descending. Allowed fields: createdAt, resolvedAt, updatedAt, status, urgency.

Response

Paginated list of signalIncidents

data

object[]

required

Show child attributes

meta

object

required

Show child attributes

List signal incidents

curl --request GET \
  --url https://connect.provisionapp.io/v1/signal-incident/list \
  --header 'x-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://connect.provisionapp.io/v1/signal-incident/list', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "conversationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "status": "pending",
      "urgency": "life_safety",
      "notificationTargetType": "partner",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "resolvedAt": "2023-11-07T05:31:56Z",
      "resolverId": "ovuid-2b6d4d8e-9f1a-4b2c-8d4e-5f6011223344"
    }
  ],
  "meta": {
    "total": 123,
    "limit": 123,
    "offset": 123
  }
}

{
  "error": {
    "code": "NOT_FOUND",
    "message": "<string>"
  }
}

{
  "error": {
    "code": "NOT_FOUND",
    "message": "<string>"
  }
}

{
  "error": {
    "code": "NOT_FOUND",
    "message": "<string>"
  }
}

{
  "error": {
    "code": "NOT_FOUND",
    "message": "<string>"
  }
}

{
  "error": {
    "code": "NOT_FOUND",
    "message": "<string>"
  }
}

{
  "error": {
    "code": "NOT_FOUND",
    "message": "<string>"
  }
}

system

site

conversation

client

label

site-file

user

project

signal-incident

List signal incidents

Authorizations

Query Parameters

Response