> ## Documentation Index
> Fetch the complete documentation index at: https://empirical.run/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# List captured webhook requests

> Returns requests sent to a capture URL.



## OpenAPI

````yaml /api-reference/openapi.generated.json get /api/webhook-captures/{token}
openapi: 3.1.0
info:
  title: Empirical API
  version: 1.0.0
  description: Programmatic access to Empirical test runs, snoozes, and more.
  contact:
    name: Empirical
    url: https://empirical.run
servers:
  - url: https://api.empirical.run
security:
  - Bearer: []
tags:
  - name: Test Runs
    description: Trigger, list, and inspect end-to-end test runs.
  - name: Test Cases
    description: >-
      Browse the Playwright test cases synced from a project's repository and
      manage their tags.
  - name: Environments
    description: >-
      Named deployment targets (slug + Playwright project filters) a project's
      tests run against.
  - name: Snoozes
    description: Temporarily suppress known test failures for specific Playwright tests.
  - name: KV
    description: >-
      Project-scoped key-value store shared by test runs, shards and agent
      sessions. Every entry expires; conditional writes make it safe for locks.
  - name: Analytics
    description: Aggregated test-run, test-count and test-case analytics for a project.
  - name: Allowed recipients
    description: >-
      Domains and addresses a project's inboxes may send email to, besides
      @empiricalrun.email addresses and people who emailed the inbox. Each one
      is verified in one of two ways. **Email from it**: send an email from the
      domain (any mailbox on it) or from the exact address to the verification
      address, with the verification code in the subject. It must pass DMARC.
      **Emailed code**, for addresses that can't send (e.g.
      `support@acme.zendesk.com`): we email the address a 6-digit code, and you
      enter it from wherever that address delivers. A domain covers exactly that
      domain, not its subdomains; add a subdomain such as `inbound.acme.com` on
      its own, and an email from `@acme.com` verifies it. Public mail providers
      (gmail.com, outlook.com and similar) can't be added as domains; add the
      exact address instead. An address also covers its plus-variants. Domains
      reserved for examples and tests (example.com, example.net, example.org,
      and anything under .test, .example, .invalid or .localhost) can't receive
      email, so codes are never emailed to them.
  - name: Badges
    description: Public README status badge images (SVG) for project environments.
  - name: Files
    description: >-
      Upload files of any type and get a link to use in tasks, sessions and
      messages. Agents should use the `upload_file` tool, which returns a
      project-wide `file@<id>` handle (`<id>` is the file `id` below).
  - name: Inboxes
    description: >-
      Test email addresses on @empiricalrun.email that a project claims. Only
      the claiming project can read an inbox, and only mail received after the
      claim. Typical flow: claim an address, sign up or log in to your app with
      it, then list the inbox's messages. Inboxes can also send mail, e.g. to
      test an app that processes inbound email: to @empiricalrun.email
      addresses, to anyone who emailed the inbox, and to the project's allowed
      recipients. Replies land back in the sending inbox.
  - name: Infra
    description: >-
      Infrastructure details customers configure against, such as static egress
      IPs.
  - name: Reporter Configuration
    description: Reporters a project can use in environment and run reporter configs.
  - name: Webhook Captures
    description: >-
      Throwaway URLs that record every request sent to them, for testing
      webhooks your app sends.
paths:
  /api/webhook-captures/{token}:
    get:
      tags:
        - Webhook Captures
      summary: List captured webhook requests
      description: Returns requests sent to a capture URL.
      operationId: listWebhookCaptures
      parameters:
        - schema:
            type: string
            minLength: 8
            maxLength: 128
            description: Capture token returned by `createWebhookCapture`.
          required: true
          description: Capture token returned by `createWebhookCapture`.
          name: token
          in: path
        - schema:
            anyOf:
              - type: string
              - type: array
                items:
                  type: string
            description: >-
              Only captures whose body contains this text. Repeat the parameter
              to require several.
          required: false
          description: >-
            Only captures whose body contains this text. Repeat the parameter to
            require several.
          name: content
          in: query
        - schema:
            type: string
            format: date-time
            description: Only captures received at or after this ISO 8601 time.
          required: false
          description: Only captures received at or after this ISO 8601 time.
          name: received_after
          in: query
        - schema:
            type: string
            enum:
              - newest
              - oldest
            default: newest
            description: Sort order by receive time.
          required: false
          description: Sort order by receive time.
          name: order
          in: query
        - schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 20
            description: Maximum captures to return (max 100).
          required: false
          description: Maximum captures to return (max 100).
          name: limit
          in: query
      responses:
        '200':
          description: Captured requests.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WebhookCaptureListResponse'
        '400':
          description: Invalid request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: The inbox service is not configured.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
components:
  schemas:
    WebhookCaptureListResponse:
      type: object
      properties:
        data:
          type: object
          properties:
            captures:
              type: array
              items:
                $ref: '#/components/schemas/WebhookCapture'
              description: Captured requests.
          required:
            - captures
          description: Response payload.
      required:
        - data
    ErrorResponse:
      type: object
      properties:
        data:
          nullable: true
          description: Always null for error responses.
        error:
          type: object
          properties:
            message:
              type: string
              description: Human-readable error message.
          required:
            - message
          description: Error details.
      required:
        - data
        - error
    WebhookCapture:
      type: object
      properties:
        id:
          type: string
          description: Capture ID.
        token:
          type: string
          description: Token the request was sent to.
        method:
          type: string
          description: HTTP method.
        headers:
          type: object
          additionalProperties:
            type: string
          description: Request headers, lowercased names.
        body:
          type: string
          nullable: true
          description: Raw request body, if any.
        query_params:
          type: object
          additionalProperties:
            type: string
          description: Query string parameters.
        received_at:
          type: string
          description: ISO 8601 time the request arrived.
      required:
        - id
        - token
        - method
        - headers
        - body
        - query_params
        - received_at
  securitySchemes:
    Bearer:
      type: http
      scheme: bearer

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.