> ## Documentation Index
> Fetch the complete documentation index at: https://docs.isnap.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# List webhook subscriptions

> Returns every webhook subscription of your account in one response, newest first, without their secrets.

* **Credential:** an account API key. A trial key returns `401 unauthorized`.
* **Line-scoped keys:** the list of a [line-scoped key](/authentication#line-scoped-keys) is not
  applied here: the key lists every subscription of the account.
* **`Idempotency-Key`:** not needed: the operation changes nothing. See
  [Retrying safely](/idempotency#retrying-safely).
* **Events:** none.
* **Guide:** [Subscription states](/webhooks/overview#subscription-states) explains the fields this
  operation returns and why a suspended subscription still reads `active: true`. The response has
  no pages and takes no filter.

## Errors

This operation has no error of its own.

The errors that every operation shares are in [Errors](/errors-and-rate-limits#errors).


## OpenAPI

````yaml GET /v1/webhooks
openapi: 3.0.0
info:
  title: iSnap API
  version: 2.45.0
  description: >-
    The iSnap API sends and receives iMessage, RCS and SMS on real phone lines,
    manages those lines, and reports events through webhooks. Every message is
    sent to a real recipient, with an `isnap_live_` key and with an
    `isnap_test_` key alike. Retry a `429` after `Retry-After` seconds. Retry a
    `500` or a `503` up to 2 times, with exponential backoff. Do not retry any
    other `4xx`: fix the request. Retry a write only on an operation that honors
    `Idempotency-Key`, with the key of the first attempt. Responses carry
    personal data: handles, names and message text.
servers:
  - url: https://api.isnap.ai
security:
  - bearerAuth: []
paths:
  /v1/webhooks:
    get:
      summary: List webhook subscriptions
      description: >-
        Returns every webhook subscription of the account in one response,
        newest first, without pagination. Accepts an API key; a line-scoped key
        lists them all. Signing secrets are not returned. No field reports a
        suspension, and a suspended subscription still reads `active: true`. Two
        signs indicate a suspension: `failure_count` is 10 or more, or the
        deliveries of the subscription stay `pending` with `next_retry_at: null`
        in `GET /v1/webhooks/{id}/deliveries`. A suspension for a refused URL
        does not change `failure_count`. Events that occur while a subscription
        is suspended are not recorded for it: they have no delivery and cannot
        be replayed.
      responses:
        '200':
          description: The webhook subscriptions of the account.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    enum:
                      - true
                    description: Always `true` on a success response.
                  data:
                    $ref: '#/components/schemas/WebhookList'
                  trace_id:
                    type: string
                    description: >-
                      Trace id of the request that produced this response: 32
                      lowercase hexadecimal characters. Quote it when you report
                      a problem to iSnap.
                  request_id:
                    type: string
                    description: >-
                      Id of the request that produced this response: `req_`
                      followed by 25 letters or digits.
                required:
                  - success
                  - data
                  - trace_id
                  - request_id
        '400':
          description: >-
            Invalid request. `error.code` is `validation_failed` when a
            parameter, a header or the body does not match its schema:
            `error.issues` then lists each problem.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '401':
          description: No valid credential. `error.code` is `unauthorized`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '429':
          description: >-
            Too many requests. `error.code` is `rate_limit_exceeded` when more
            than 100 requests came from the same network address in 60 seconds,
            whatever their API key or account: wait `error.retry_after` seconds.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '500':
          description: >-
            Unexpected failure. `error.code` is `internal_error`. An operation
            that takes a JSON body also returns it when the body, sent as
            `application/json`, is not valid JSON. Quote `trace_id` when you
            report it to iSnap.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
      security:
        - bearerAuth: []
components:
  schemas:
    WebhookList:
      type: object
      properties:
        webhooks:
          type: array
          items:
            $ref: '#/components/schemas/Webhook'
          description: Every webhook subscription of the account, newest first.
      required:
        - webhooks
      description: The webhook subscriptions of the account.
    ErrorEnvelope:
      type: object
      properties:
        success:
          type: boolean
          enum:
            - false
          description: Always `false` on an error response.
        data:
          nullable: true
          description: Always `null` on an error response.
        error:
          type: object
          properties:
            status:
              type: integer
              description: The HTTP status of the response.
            code:
              type: string
              description: >-
                Stable machine-readable code that names the refusal. Branch on
                this value.
            message:
              type: string
              description: >-
                Text for a person. It can change between versions: do not branch
                on it.
            retry_after:
              type: integer
              nullable: true
              description: >-
                Seconds to wait before the next attempt. Set on the `429`
                responses that know a delay, where the `Retry-After` header
                carries the same value. When it is above 60 seconds, do not wait
                in a request: schedule the call, or report the time. `null` on
                every other error.
            retry_at:
              type: string
              nullable: true
              description: >-
                ISO 8601 timestamp at which the refusal ends. Set only on `429
                rebind_cap_reached`. `null` on every other error.
            issues:
              type: array
              nullable: true
              items:
                type: object
                properties:
                  path:
                    type: array
                    items:
                      anyOf:
                        - type: string
                        - type: number
                    description: >-
                      Where the problem is: the field names and array indexes
                      that lead to it.
                  message:
                    type: string
                    description: Text for a person.
                  code:
                    type: string
                    description: >-
                      Kind of problem. On `validation_failed`, for example
                      `invalid_type`, `invalid_value`, `invalid_format`,
                      `invalid_union`, `invalid_key`, `invalid_element`,
                      `too_small`, `too_big`, `not_multiple_of`,
                      `unrecognized_keys` or `custom`. The list is open: read
                      `path` and `message`.
                  min:
                    type: integer
                    description: >-
                      Smallest accepted value. Present only on
                      `limit_out_of_bounds`, `mac_quantity_not_a_pack`,
                      `byop_reduction_strands_mac_sessions` and
                      `byop_reduction_strands_byod_lines`.
                  max:
                    type: integer
                    description: >-
                      Largest accepted value. Present only on
                      `limit_out_of_bounds` and
                      `mac_sessions_exceed_byop_lines`, and on the `too_big`
                      issue of an `Idempotency-Key` header longer than 255
                      characters.
                required:
                  - path
                  - message
                  - code
              description: >-
                Problems found in the request, one entry each. Set on most `400
                validation_failed` responses and on the refusals that name a
                field: a refused `handle` of `POST /v1/lookup` has `issues:
                null`. `null` on every other error.
          required:
            - status
            - code
            - message
            - retry_after
            - retry_at
            - issues
          description: >-
            What went wrong. The six fields are always present; `retry_after`,
            `retry_at` and `issues` are `null` when they do not apply.
        trace_id:
          type: string
          description: >-
            Trace id of the request that produced this response: 32 lowercase
            hexadecimal characters. Quote it when you report a problem to iSnap.
        request_id:
          type: string
          description: >-
            Id of the request that produced this response: `req_` followed by 25
            letters or digits.
      required:
        - success
        - data
        - error
        - trace_id
        - request_id
      description: The body of an error response.
    Webhook:
      type: object
      properties:
        id:
          type: string
          pattern: ^wh_[0-9A-Za-z]{25}$
          description: >-
            Id of the webhook subscription: `wh_` followed by 25 letters or
            digits.
          example: wh_3Kp8Rn9Fh2Lm5Qx7Vw1Yz4Bc6
        url:
          type: string
          description: URL that receives the deliveries.
        events:
          nullable: true
          description: >-
            Event filter: an array of exact event types, family wildcards such
            as `line.*`, or `*`. Never `null`.
        line_ids:
          nullable: true
          description: >-
            Line filter: an array of line ids, or `null`. `null` and an empty
            array both mean every line.
        active:
          type: boolean
          description: >-
            `false` when you turned the subscription off, or when the URL
            returned `410` to a delivery. A subscription that iSnap suspended
            stays `true`: no field reports a suspension.
        failure_count:
          type: integer
          minimum: 0
          description: >-
            Number of consecutive deliveries that used all their attempts
            without a response from `200` to `299`. A successful delivery, or a
            successful `webhook.test` request, resets it to 0. iSnap suspends
            the subscription when it reaches 10.
        last_success_at:
          type: string
          nullable: true
          description: >-
            Timestamp of the last response from `200` to `299`, to a delivery or
            to a `webhook.test` request. `null` until the first one.
        last_failure_at:
          type: string
          nullable: true
          description: >-
            Timestamp of the last delivery that used all its attempts, of the
            last `410` response, or of the last delivery that was not sent
            because the URL no longer passed the URL checks. `null` until the
            first one.
        created_at:
          type: string
          description: Timestamp of creation, ISO 8601 in UTC.
        secret:
          type: string
          description: >-
            Signing secret: `whsec_` followed by 64 lowercase hexadecimal
            characters. Present in the response of `POST /v1/webhooks` only.
            Pass it as it is to a Standard Webhooks library. The HMAC key is the
            base64 decoding of the part after `whsec_`, not its hexadecimal
            decoding.
      required:
        - id
        - url
        - active
        - failure_count
        - last_success_at
        - last_failure_at
        - created_at
      description: >-
        A webhook subscription, in the shape that `POST /v1/webhooks` and `GET
        /v1/webhooks` return.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        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.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.