---
title: "Get webhook subscriptions"
method: GET
path: "/webhooks"
tags: ["Webhooks"]
---

# Get webhook subscriptions

`GET /webhooks`

## Request

- Base URL: `https://api.smokeball.com`
- URL: `https://api.smokeball.com/webhooks`
- Auth: API key in header `x-api-key` and API key in header `Authorization`

Returns existing webhook subscriptions.

## Query parameters

- `Offset` integer
- `Limit` integer

## Response `200`

When request is successful. Returns existing webhook subscriptions.

- WebhookSubscriptionPagedCollection
  - `id` string, nullable
  - `href` string, nullable
  - `relation` string, nullable
  - `method` string, nullable
  - `self` Link
    - `id` string, nullable
    - `href` string, nullable
    - `relation` string, nullable
    - `method` string, nullable
  - `value` WebhookSubscription[], nullable
    - `id` string, nullable
    - `href` string, nullable
    - `relation` string, nullable
    - `method` string, nullable
    - `self` Link
      - `id` string, nullable
      - `href` string, nullable
      - `relation` string, nullable
      - `method` string, nullable
    - `accountId` string, nullable: Unique identifier of the associated account.
    - `name` string, nullable: Name or description of the subscription.
    - `eventTypes` string[], nullable: The event types that the webhook subscription is subscribed to.
    - `eventNotificationUrl` string, nullable: The uri to notify when an event has occurred.
    - `createdDateUtc` string, date-time: The webhook subscription creation date.
    - `updatedDateUtc` string, date-time: The webhook subscription last updated date.
    - `lastUpdated` integer: Last updated timestamp
  - `offset` integer, nullable
  - `limit` integer, nullable
  - `size` integer
  - `first` Link
    - `id` string, nullable
    - `href` string, nullable
    - `relation` string, nullable
    - `method` string, nullable
  - `previous` Link
    - `id` string, nullable
    - `href` string, nullable
    - `relation` string, nullable
    - `method` string, nullable
  - `next` Link
    - `id` string, nullable
    - `href` string, nullable
    - `relation` string, nullable
    - `method` string, nullable
  - `last` Link
    - `id` string, nullable
    - `href` string, nullable
    - `relation` string, nullable
    - `method` string, nullable

## Other responses

- `400`: When an unsupported request is made.

---

[API](https://skmtc.dev/smokeball/apis/smokeball-api.md) - [All operations](https://skmtc.dev/smokeball/apis/smokeball-api/llms.txt) - [OpenAPI document](https://skmtc.dev/smokeball/apis/smokeball-api/revisions/6e350cf667d4?raw)