Skip to content
The Desk

Show a webhook subscription

GET
/webhooks/{webhookSubscription}
curl --request GET \
  --url https://desk.example.com/api/v1/webhooks/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Authorization: Bearer <token>'

Required scope: webhooks:read

The subscription, with its 20 most recent delivery attempts.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “ Parameters ”

Path Parameters

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

The subscription’s id.

Responses

Section titled “ Responses ”

200

Section titled “200”

The subscription and its recent deliveries.

Media typeapplication/json
object
data
required
object
id
required
string format: uuid
name
required
string
url
required
string format: uri
events
required
Array<string>
Allowed values: message.created message.updated message.deleted reaction.added channel.member_added
channel_ids
required

Null when the subscription is workspace-wide.

Array<string> | null
status
required

A subscription is disabled automatically after repeated delivery failures.

string
Allowed values: active disabled
consecutive_failures
required
integer
last_success_at
required
string | null format: date-time
disabled_at
required
string | null format: date-time
created_at
required
string | null format: date-time
deliveries
required
Array<object>

One attempt to deliver an event to a subscription’s endpoint.

object
id
required
string format: uuid
event_type
required

An event an outgoing-webhook subscription can listen for.

string
Allowed values: message.created message.updated message.deleted reaction.added channel.member_added
event_id
required

The id of the event delivered, for de-duplicating on your side.

string format: uuid
succeeded
required
boolean
response_status
required

The endpoint’s HTTP status, or null when the request never completed.

integer | null
error
required
string | null
created_at
required
string | null format: date-time
Example
{
  "data": {
    "events": [
      "message.created"
    ],
    "status": "active",
    "deliveries": [
      {
        "event_type": "message.created"
      }
    ]
  }
}

401

Section titled “401”

The token is missing, malformed, or revoked.

Media typeapplication/json

The shape every error response carries.

object
message
required
string
Examplegenerated
{
  "message": "example"
}

403

Section titled “403”

The token lacks the scope this operation requires, or its subject may see the resource but not perform this action on it.

Media typeapplication/json

The shape every error response carries.

object
message
required
string
Examplegenerated
{
  "message": "example"
}

404

Section titled “404”

The resource does not exist, is outside the token’s workspace, or the integrations platform is disabled. A channel the subject cannot see is reported here rather than as a 403, so the API never leaks its existence.

Media typeapplication/json

The shape every error response carries.

object
message
required
string
Examplegenerated
{
  "message": "example"
}

429

Section titled “429”

The per-token rate limit (INTEGRATIONS_API_RATE_LIMIT requests per minute) was exceeded. Retry after the Retry-After header.

Media typeapplication/json

The shape every error response carries.

object
message
required
string
Examplegenerated
{
  "message": "example"
}

Headers

Section titled “Headers”
Retry-After
integer

Seconds to wait before retrying.