signal-incident

Resolve a Signal Incident

Closes an open Signal Incident, recording resolverUserId as the person who resolved it, exactly as resolving it in the ProVision portal would — the same status and timestamp are written and the incident’s Slack messages are updated to show it was resolved. Idempotent: resolving an already-resolved incident succeeds, changes nothing, and keeps the original resolver and resolution time. An incident that was canceled (superseded by a newer one) cannot be resolved and is rejected with 400. Requires the signalIncident:write scope.

POST

signal-incident

{id}

resolve

Resolve a Signal Incident

curl --request POST \
  --url https://connect.provisionapp.io/v1/signal-incident/{id}/resolve \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "resolverUserId": "ovuid-2b6d4d8e-9f1a-4b2c-8d4e-5f6011223344"
}
'

const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({resolverUserId: 'ovuid-2b6d4d8e-9f1a-4b2c-8d4e-5f6011223344'})
};

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

import requests

url = "https://connect.provisionapp.io/v1/signal-incident/{id}/resolve"

payload = { "resolverUserId": "ovuid-2b6d4d8e-9f1a-4b2c-8d4e-5f6011223344" }
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "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"
}

{
  "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.

Path Parameters

string<uuid>

required

Example:

"57f2d879-20f8-4106-9abb-44fa099e0448"

Body

application/json

resolverUserId

string

required

Platform user recorded as the resolver. Must belong to your partner and be active. Newer ids are ovuid-<uuid>; legacy users may have bare (e.g. numeric) ids.

Minimum string length: 1

Example:

"ovuid-2b6d4d8e-9f1a-4b2c-8d4e-5f6011223344"

Response

The incident in its resolved state

string<uuid>

required

conversationId

string<uuid>

required

status

enum<string>

required

Available options:

pending,

canceled,

resolved,

ignored

urgency

enum<string> | null

required

Available options:

life_safety,

urgent,

normal,

low,

null

notificationTargetType

enum<string> | null

required

Who was notified about this incident. partner means the partner's own on-call agents; platform means ProVision internal staff.

Available options:

partner,

platform,

null

createdAt

string<date-time>

required

updatedAt

string<date-time>

required

resolvedAt

string<date-time> | null

required

When an agent resolved the incident. Null while it is unresolved.

resolverId

string | null

required

Id of the user who resolved the incident. May reference a ProVision internal user, who is not visible through /v1/user/list.

Example:

"ovuid-2b6d4d8e-9f1a-4b2c-8d4e-5f6011223344"

Resolve a Signal Incident

curl --request POST \
  --url https://connect.provisionapp.io/v1/signal-incident/{id}/resolve \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "resolverUserId": "ovuid-2b6d4d8e-9f1a-4b2c-8d4e-5f6011223344"
}
'

const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({resolverUserId: 'ovuid-2b6d4d8e-9f1a-4b2c-8d4e-5f6011223344'})
};

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

import requests

url = "https://connect.provisionapp.io/v1/signal-incident/{id}/resolve"

payload = { "resolverUserId": "ovuid-2b6d4d8e-9f1a-4b2c-8d4e-5f6011223344" }
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "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"
}

{
  "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

Resolve a Signal Incident

Authorizations

Path Parameters

Body

Response