---
title: "Retrieve webhooks"
method: GET
path: "/webhook"
tags: ["Webhook"]
---

# 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_created' | '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` string
- `per_page` string
- `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, uri — URL of the first page in the result set.
  - `from` integer — Position of the first record on this page within the full result set. The first record is at position `1`.
  - `last_page` integer — Number of the last page. Equals the total number of pages.
  - `last_page_url` string, uri — URL of the last page in the result set.
  - `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, uri — 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 — Position of the last record on this page within the full result set.
  - `total` integer — Total number of records across all pages.
  - `data` Webhook[]
    - `events` string[] — Subscription events that trigger this webhook.
    - `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.
    - `updated` string, date-time — Date and time the webhook was last updated.

---

[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/b70a2ea056c3/schema)