Skip to main content
GET
Get a webhook subscription
  • Credential: an account API key. A trial key returns 401 unauthorized.
  • Line-scoped keys: the list of a line-scoped key is not applied here: the key reads any subscription of the account.
  • Idempotency-Key: not needed: the operation changes nothing. See Retrying safely.
  • Events: none.
  • Guide: Subscription states. This operation does not return failure_count, last_success_at and last_failure_at: read them with GET /v1/webhooks.

Errors

The errors that every operation shares are in Errors.

Authorizations

Authorization
string
header
required

An API key created in the iSnap dashboard, or a trial key, sent as Authorization: Bearer <key>. An API key starts with isnap_live_ or isnap_test_; both act on the same account, lines and billing. A trial key acts on its trial only.

Path Parameters

id
string
required

Id of the webhook subscription, as returned in id by POST /v1/webhooks: wh_ followed by 25 letters or digits.

Pattern: ^wh_[0-9A-Za-z]{25}$
Example:

"wh_3Kp8Rn9Fh2Lm5Qx7Vw1Yz4Bc6"

Response

The webhook subscription.

success
enum<boolean>
required

Always true on a success response.

Available options:
true
data
object
required

A webhook subscription, in the shape that GET /v1/webhooks/{id} and PATCH /v1/webhooks/{id} return.

trace_id
string
required

Trace id of the request that produced this response: 32 lowercase hexadecimal characters. Quote it when you report a problem to iSnap.

request_id
string
required

Id of the request that produced this response: req_ followed by 25 letters or digits.