--- title: "Retrieve webhooks" method: GET path: "/webhook" tags: ["Webhooks"] --- # Retrieve webhooks `GET /webhook` Retrieves webhooks. ## Query parameters - `http_method` 'get' | 'post' - `subscription_event` 'allocation_created' | 'allocation_payment_created' | 'allocation_payment_deleted' | 'allocation_payment_status_changed' | 'allocation_payment_updated' | 'assignment_completed' | 'assignment_created' | 'collaborator_invited' | 'document_created' | 'document_deleted' | 'document_updated' | 'entry_category_changed' | 'entry_chapter_changed' | 'entry_copied' | 'entry_created' | 'entry_deleted' | 'entry_eligible' | 'entry_ineligible' | 'entry_moderated' | 'entry_resubmitted' | 'entry_submitted' | 'entry_tagged' | 'entry_updated' | 'field_value_updated' | 'membership_registered' | 'payment_pending' | 'payment_success' | 'review_task_created' | 'review_task_submitted' | 'role_granted' | 'user_updated' - `url` string - `page` number - `per_page` number - `order` 'events' | 'http_method' | 'notification_emails' | 'signing_keys' | 'title' | 'updated' | 'url' - `dir` 'asc' | 'desc' ## Headers - `Accept` 'application/vnd.Creative Force.v2.3+json' | 'application/vnd.Creative Force.v2.3+xml', required ## Response `200` Webhooks retrieved. - WebhookList — Pagination envelope returned by every list endpoint. Wraps the result set with positional fields (`current_page`, `from`, `to`, `total`) and navigation URLs (`first_page_url`, `last_page_url`, `next_page_url`, `prev_page_url`) for traversing the full list. The records themselves are returned in a sibling `data` array supplied by the wrapping schema. - `current_page` integer — Number of the page returned by this response. The first page is `1`. - `first_page_url` string — URL of the first page in the result set. Relative when the requested page is beyond the last page. - `from` integer, nullable — Position of the first record on this page within the full result set. The first record is at position `1`. `null` when the requested page is beyond the last page. - `last_page` integer — Number of the last page. Equals the total number of pages. - `last_page_url` string — URL of the last page in the result set. Relative when the requested page is beyond the last page. - `next_page_url` string — URL of the next page in the result set. Empty string when the current page is the last page. - `path` string — Canonical URL of the endpoint, without query parameters. - `per_page` integer — Maximum number of records returned per page. - `prev_page_url` string — URL of the previous page in the result set. Empty string when the current page is the first page. - `to` integer, nullable — Position of the last record on this page within the full result set. `null` when the requested page is beyond the last page. - `total` integer — Total number of records across all pages. - `data` 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. - `429` — Rate limit of 60 requests per minute exceeded. - `503` — Service is temporarily unavailable due to regional maintenance. ## Changes - **2026-07-13** (v2) `e2511e46f9f2` — 2 breaking, 2 info - for the `query` request parameter `page`, the type/format was changed from `string`/`` to `number`/`` - for the `query` request parameter `per_page`, the type/format was changed from `string`/`` to `number`/`` - the `per_page` response's property default value `10` was added for the status `200` (media type: application/json) - the `per_page` response's property default value `10` was added for the status `200` (media type: application/xml) - **2026-07-08** (v2) `a269ebb35abf` — 10 breaking - the response property `allOf[subschema #1: Pagination]/from` became nullable for the status `200` (media type: application/json) - the response property `allOf[subschema #1: Pagination]/from` became nullable for the status `200` (media type: application/xml) - the response property `allOf[subschema #1: Pagination]/to` became nullable for the status `200` (media type: application/json) - the response property `allOf[subschema #1: Pagination]/to` became nullable for the status `200` (media type: application/xml) - …6 more - **2026-07-07** (v2) `9b9103538ceb` — 2 info - api tag `Webhooks` added - api tag `Webhook` removed - …earlier changes not shown [Full history](https://skmtc.dev/tectonic/apis/award-force-api/changes/webhook/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)