# Retrieve a webhook subscription

> Retrieve a webhook subscription by its identifier.
{/* generated:versioned-pages - edit _pm-authored, not this file */}

`GET /api/webhook_subscriptions/{id}`

Retrieves a WebhookSubscription resource.

Returns a single webhook subscription by id, with its `topic`, `callbackUrl`, pinned `version` and `includeFields`. The signing secret is not returned. This endpoint is only available in the `unstable` version.

## Path parameters

| Name | Type     | Required | Description                    |
| ---- | -------- | -------- | ------------------------------ |
| `id` | `string` | Yes      | WebhookSubscription identifier |

## Query parameters

| Name           | Type       | Required | Description                                                                                                                                                                                                                                                                          |
| -------------- | ---------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `properties[]` | `string[]` | -        | Allows you to reduce the response to contain only the properties you need. If your desired property is nested, you can address it using nested arrays. Example: properties[]={propertyName}&properties[]={anotherPropertyName}&properties[{nestedPropertyParent}][]={nestedProperty} |

## Response

**200** - WebhookSubscription resource

| Property        | Type               | Required | Description                                                                                                                                                                   |
| --------------- | ------------------ | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `@context`      | `string \| object` | -        |                                                                                                                                                                               |
| `@id`           | `string`           | Yes      |                                                                                                                                                                               |
| `@type`         | `string`           | Yes      |                                                                                                                                                                               |
| `callbackUrl`   | `string \| null`   | -        | The HTTPS endpoint notified when the topic fires.                                                                                                                             |
| `createdAt`     | `string`           | -        |                                                                                                                                                                               |
| `id`            | `string`           | -        |                                                                                                                                                                               |
| `includeFields` | `array \| null`    | -        | Dot-path field selection limiting the delivered payload. Null or empty means the full payload. A `*` segment is a wildcard (e.g. `*.id`); the resource id is always included. |
| `topic`         | `string \| null`   | -        | The event topic to subscribe to.                                                                                                                                              |
| `updatedAt`     | `string`           | -        |                                                                                                                                                                               |
| `version`       | `string \| null`   | -        | The pinned payload API version, or null when dynamic.                                                                                                                         |

## Errors

**403** - Access denied. The caller is missing one or more permissions required for this operation.

| Property             | Type               | Required | Description                                                                                                            |
| -------------------- | ------------------ | -------- | ---------------------------------------------------------------------------------------------------------------------- |
| `@context`           | `string \| object` | -        |                                                                                                                        |
| `@id`                | `string`           | Yes      |                                                                                                                        |
| `@type`              | `string`           | Yes      |                                                                                                                        |
| `detail`             | `string`           | -        |                                                                                                                        |
| `missingPermissions` | `string[]`         | -        | Permissions that the caller is missing for this operation. Present only when the 403 is caused by a denied permission. |
| `status`             | `integer`          | -        |                                                                                                                        |
| `title`              | `string`           | -        |                                                                                                                        |
| `type`               | `string`           | -        |                                                                                                                        |

**404** - Not found

| Property      | Type               | Required | Description                                                                                                                          |
| ------------- | ------------------ | -------- | ------------------------------------------------------------------------------------------------------------------------------------ |
| `@context`    | `string \| object` | -        |                                                                                                                                      |
| `@id`         | `string`           | Yes      |                                                                                                                                      |
| `@type`       | `string`           | Yes      |                                                                                                                                      |
| `code`        | `string`           | -        | Stable identifier of the error in the error code catalogue (see /api/error-codes). Present on catalogued errors only.                |
| `description` | `string \| null`   | -        |                                                                                                                                      |
| `detail`      | `string \| null`   | -        | A human-readable explanation specific to this occurrence of the problem.                                                             |
| `instance`    | `string \| null`   | -        | A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced. |
| `message`     | `string`           | -        | End-user message localized in the request locale, with this occurrence's values substituted. Present on catalogued errors only.      |
| `slug`        | `string`           | -        | Stable, readable key of the error in the error code catalogue. Present on catalogued errors only.                                    |
| `status`      | `integer \| null`  | -        |                                                                                                                                      |
| `title`       | `string \| null`   | -        | A short, human-readable summary of the problem. For a catalogued error it repeats the `slug`.                                        |
| `type`        | `string`           | -        | A URI reference that identifies the problem type. For a catalogued error it is the error code resource, `/api/error-codes/{code}`.   |

## Examples

### Example request

```bash
curl -X GET 'https://<tenant>.product-management.flowkiwi.net/api/webhook_subscriptions/<product_id>' \
  -H 'Authorization: Bearer {access_token}' \
  -H 'Flowkiwi-Api-Version: unstable' \
  -H 'Accept: application/ld+json'
```