Skip to content
Site Qwality Site Qwality Site Qwality Docs

Turn off an integration.

POST
/v1/integrations/{integration_id}/disable
 
curl --request POST \
  --url https://api.siteqwality.com/v1/integrations/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/disable \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
integration_id
required
string format: uuid

Header Parameters

Section titled “Header Parameters ”
Idempotency-Key
string
<= 255 characters

Makes a retry safe: the same key and body within 24 hours returns the first response with Idempotent-Replayed: true. The same key with another body is refused with 422 idempotency_key_reused, and one still running with 409 idempotency_key_in_use.

Responses

Section titled “ Responses ”

200

Section titled “200 ”

The integration, which sends nothing until enabled

Media type application/json
object
id
required
string format: uuid
account_id
required
string format: uuid
friendly_name
required
string
type
required
string
Allowed values: slack webhook telegram discord microsoft_teams pagerduty opsgenie google_chat mattermost pushover pushbullet
details
required
One of:
object
slack_token
required

Masked bot token, e.g. ****abcd.

string
external_ref
One of:

Where a PagerDuty or JSM/Opsgenie integration sends. null on every other type.

object
region

PagerDuty service region: us or eu.

string | null
endpoint

JSM/Opsgenie endpoint: jsm, opsgenie_us or opsgenie_eu.

string | null
created_at
required
string format: date-time
health
One of:

How deliveries through it are going. Only the list carries it.

object
state
required
string
Allowed values: healthy degraded failing skipped untested disabled quiet
reason

Why it is not healthy: the vendor’s words or a skip slug.

string | null
last_delivery
One of:

The newest receipt, skips by design included.

object
id
required
string format: uuid
at
required
string format: date-time
status
required

Sent | delivered | delayed | soft_bounced | failed | rejected | bounced | complained | skipped

string
reason

The vendor’s reason for a non-success status, URLs cut to hosts; a slug for skipped.

string | null
channel

Slack | webhook | pagerduty | …

string | null
destination

Masked: a Slack channel, a webhook host.

string | null
source_kind

What produced it, such as http_transition; null on older rows.

string | null
event_kind

What happened, such as down; null on older rows.

string | null
why

The older slug for why it was sent, such as monitor_down.

string | null
monitor_id

The monitor it was about, and which table: http | cron | browser | page_speed | tls | dns.

string | null format: uuid
monitor_type
string | null
is_test
required

A test send from the dashboard.

boolean
webhook_delivery_id

For a webhook, the delivery whose attempts the webhook log shows.

string | null format: uuid
disabled
One of:

Set while it is turned off. The list and the enable and disable answers carry it.

object
at
required
string format: date-time
reason
required

Customer | auto_failing | app_uninstalled | auth_revoked

string
monthly_check

Microsoft Teams only: whether a check card goes out each month to keep the flow running. The list and edits that set it carry it.

boolean | null
webhook_request
One of:

Webhooks only: the custom header names and the auth type it sends, never a value. The list and edits carry it.

object
headers
Array<string>
auth

bearer or basic; absent when there is none.

string | null
username
string | null
routed

Whether anything sends through it: a channel in a group, a service target or a contact method. Only the list carries it.

boolean | null
Example 
{
  "type": "slack",
  "external_ref": {
    "region": "eu",
    "endpoint": "jsm"
  },
  "health": {
    "state": "healthy"
  }
}

Headers

Section titled “Headers ”
Idempotent-Replayed
string

true when this is the stored first response

401

Section titled “401 ”

Missing or invalid credentials

Media type application/problem+json

An RFC 9457 problem, the body of every /v1 error.

object
type
required

https://docs.siteqwality.com/errors/ and the failure’s code, such as not_found.

string
title
required
string
status
required
integer format: int32
detail
string | null
instance

urn:uuid: and the request id.

string | null
errors

The invalid fields, when the request body was refused.

array | null

One validation failure; pointer is an RFC 6901 pointer into the request body.

object
pointer
required
string
detail
required
string
Example generated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example",
  "errors": [
    {
      "pointer": "example",
      "detail": "example"
    }
  ]
}

403

Section titled “403 ”

The key or member may not do this, or lacks the scope it needs

Media type application/problem+json

An RFC 9457 problem, the body of every /v1 error.

object
type
required

https://docs.siteqwality.com/errors/ and the failure’s code, such as not_found.

string
title
required
string
status
required
integer format: int32
detail
string | null
instance

urn:uuid: and the request id.

string | null
errors

The invalid fields, when the request body was refused.

array | null

One validation failure; pointer is an RFC 6901 pointer into the request body.

object
pointer
required
string
detail
required
string
Example generated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example",
  "errors": [
    {
      "pointer": "example",
      "detail": "example"
    }
  ]
}

404

Section titled “404 ”

No such integration in this account

Media type application/problem+json

An RFC 9457 problem, the body of every /v1 error.

object
type
required

https://docs.siteqwality.com/errors/ and the failure’s code, such as not_found.

string
title
required
string
status
required
integer format: int32
detail
string | null
instance

urn:uuid: and the request id.

string | null
errors

The invalid fields, when the request body was refused.

array | null

One validation failure; pointer is an RFC 6901 pointer into the request body.

object
pointer
required
string
detail
required
string
Example generated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example",
  "errors": [
    {
      "pointer": "example",
      "detail": "example"
    }
  ]
}

429

Section titled “429 ”

Too many requests; wait for the time in Retry-After

Media type application/problem+json

An RFC 9457 problem, the body of every /v1 error.

object
type
required

https://docs.siteqwality.com/errors/ and the failure’s code, such as not_found.

string
title
required
string
status
required
integer format: int32
detail
string | null
instance

urn:uuid: and the request id.

string | null
errors

The invalid fields, when the request body was refused.

array | null

One validation failure; pointer is an RFC 6901 pointer into the request body.

object
pointer
required
string
detail
required
string
Example generated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example",
  "errors": [
    {
      "pointer": "example",
      "detail": "example"
    }
  ]
}

Privacy Cookie preferences