---
title: "Retrieve a webhook"
method: GET
path: "/webhook/{webhook_slug}"
tags: ["Webhooks"]
---

# Retrieve a webhook

`GET /webhook/{webhook_slug}`

Retrieves the webhook identified by the specified slug.

## Path parameters

- `webhook_slug` string, required

## Headers

- `Accept` 'application/vnd.Creative Force.v2.3+json' | 'application/vnd.Creative Force.v2.3+xml', required
- `x-api-language` string[]

## Response `200`

Webhook retrieved.

- Webhook
  - `events` string[] — Subscription events that trigger this webhook.
  - `fields` object[] — Fields included in the webhook payload.
    - `slug` string — Short URL-safe identifier for the field.
    - `link` string, uri — Canonical URL for the field resource.
    - `title` object — Plain-text title of the field. Map keyed by locale code (for example, `en_GB` or `fr_FR`). Keys are drawn from the languages enabled on the account. Values are the translated string.
  - `form` string, nullable — Slug of the form the webhook is scoped to. `null` when the webhook is not scoped to a specific form.
  - `method` 'get' | 'post' — HTTP method used to call the webhook URL.
  - `name` string — Name of the webhook.
  - `slug` string — Slug of the webhook.
  - `signing_key` string — Key used to sign outgoing webhook requests so the receiver can validate the payload.
  - `url` string, uri — URL that receives the webhook payload.
  - `created` string, date-time — Date and time the webhook was created.
  - `updated` string, date-time — Date and time the webhook was last updated.

## Other responses

- `400` — Request was rejected before the endpoint could process it. Common causes: invalid `Accept` header, unsupported `x-api-language` code, empty request body on `POST` / `PUT`, invalid JSON in the request body, or an invalid slug format in a path parameter.
- `401` — Missing `x-api-key` header.
- `403` — Authenticated request denied. Common causes: invalid or unknown API key, suspended account, or `api` feature not enabled for the account.
- `404` — Resource identified by the path slug does not exist. Returned when the slug is well-formed but no record matches it.
- `429` — Rate limit of 60 requests per minute exceeded.
- `503` — Service is temporarily unavailable due to regional maintenance.

## Changes

- **2026-07-07** (v2) `9b9103538ceb` — 2 info
  - api tag `Webhooks` added
  - api tag `Webhook` removed
- **2026-07-01** (v2) `e96a96d4507e` — 7 info
  - added the media type `application/xml` for the response with the status `200`
  - added the media type `application/xml` for the response with the status `400`
  - added the media type `application/xml` for the response with the status `401`
  - added the media type `application/xml` for the response with the status `403`
  - …3 more
- **2026-06-30** (v2) `a1f4e2d17c6b` — 1 breaking, 7 info
  - added the pattern `^[A-Za-z]{8}$` to the `path` request parameter `webhook_slug`
  - added the new optional `header` request parameter `x-api-language`
  - added the non-success response with the status `400`
  - added the non-success response with the status `401`
  - …4 more
- **2026-06-29** (v2) `755cc7930718` — 3 info
  - added the optional property `created` to the response with the `200` status
  - added the optional property `fields` to the response with the `200` status
  - added the optional property `form` to the response with the `200` status

[Change history](https://skmtc.dev/tectonic/apis/award-force-api/changes/webhook/:webhook_slug/get.md)

---

[API](https://skmtc.dev/tectonic/apis/award-force-api.md) · [All operations](https://skmtc.dev/tectonic/apis/award-force-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/tectonic/award-force-api/revisions/e2511e46f9f2/schema)
