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

# Retrieve a replay

> A replay's progress: how many deliveries it has resent so far and whether it has finished.



## OpenAPI

````yaml /api-reference/specs/webhooks.json get /replays/{replayId}
openapi: 3.1.1
info:
  title: Webhooks Service
  description: >-
    Outbound webhooks for FlowPayroll: register an endpoint, subscribe to event
    types, manage signing secrets, inspect the delivery log and replay.
  version: v1
servers:
  - url: https://api.sandbox.flowpayroll.ai/v1/webhooks
security:
  - X-Auth-Token: []
tags:
  - name: Alert contacts
  - name: Delivery log
  - name: Endpoint subscriptions
  - name: Endpoints
  - name: Event types
  - name: Events
  - name: Replays
paths:
  /replays/{replayId}:
    get:
      tags:
        - Replays
      summary: Retrieve a replay
      description: >-
        A replay's progress: how many deliveries it has resent so far and
        whether it has finished.
      operationId: GetReplay
      parameters:
        - name: replayId
          in: path
          required: true
          schema:
            type: string
        - name: scope
          in: query
          description: >-
            Whose resources: your organisation's (the default), or with
            account-wide access the account's (`customer`).
          schema:
            enum:
              - organisation
              - customer
            type: string
            default: organisation
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReplayJobResponseResponseBody'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectResponseBody'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectResponseBody'
components:
  schemas:
    ReplayJobResponseResponseBody:
      type: object
      properties:
        message:
          $ref: '#/components/schemas/MessageWithTokenResponse'
        content:
          $ref: '#/components/schemas/ReplayJobResponseContentResponse'
        validationIssues:
          type:
            - 'null'
            - array
          items:
            $ref: '#/components/schemas/ValidationIssue'
      additionalProperties: false
    ObjectResponseBody:
      type: object
      properties:
        message:
          $ref: '#/components/schemas/MessageWithTokenResponse'
        content:
          $ref: '#/components/schemas/ObjectContentResponse'
        validationIssues:
          type:
            - 'null'
            - array
          items:
            $ref: '#/components/schemas/ValidationIssue'
      additionalProperties: false
    MessageWithTokenResponse:
      type: object
      properties:
        text:
          type: string
        token:
          type: string
        tokenArguments:
          type:
            - 'null'
            - array
          items:
            $ref: '#/components/schemas/ValidationIssueArgument'
      additionalProperties: false
    ReplayJobResponseContentResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/ReplayJobResponse'
        metadata:
          $ref: '#/components/schemas/ContentMetadataResponse'
      additionalProperties: false
    ValidationIssue:
      type: object
      properties:
        field:
          type: string
        reason:
          type: string
        reasonToken:
          type: string
        reasonTokenArguments:
          type:
            - 'null'
            - array
          items:
            $ref: '#/components/schemas/ValidationIssueArgument'
      additionalProperties: false
    ObjectContentResponse:
      type: object
      properties:
        data:
          type: 'null'
        metadata:
          $ref: '#/components/schemas/ContentMetadataResponse'
      additionalProperties: false
    ValidationIssueArgument:
      type: object
      properties:
        name:
          type: string
        value:
          type: 'null'
      additionalProperties: false
    ReplayJobResponse:
      required:
        - createdDate
        - ownerId
        - replayId
        - replayed
        - request
        - scope
        - status
      type: object
      properties:
        replayId:
          type: string
        status:
          enum:
            - Queued
            - Running
            - Completed
            - Cancelled
          type: string
        scope:
          enum:
            - Organisation
            - Customer
          type: string
        ownerId:
          type: string
        request:
          $ref: '#/components/schemas/CreateReplayRequest'
        replayed:
          type: integer
          format: int32
        createdDate:
          type: string
        finishedDate:
          type:
            - 'null'
            - string
      additionalProperties: false
    ContentMetadataResponse:
      type: object
      properties:
        dateFormat:
          type: string
        dateTimeFormat:
          type: string
        paginationToken:
          type:
            - 'null'
            - string
          description: >-
            Cursor for the next page, present only when more results follow and
            null on the last page. Pass it back unmodified to continue; it is
            opaque and short-lived, so do not store it.
      additionalProperties: false
    CreateReplayRequest:
      required:
        - endDate
        - startDate
      type: object
      properties:
        endpointIds:
          type:
            - 'null'
            - array
          items:
            type: string
        eventTypes:
          type:
            - 'null'
            - array
          items:
            type: string
        statuses:
          type:
            - 'null'
            - array
          items:
            enum:
              - Pending
              - Succeeded
              - Failed
              - Skipped
            type: string
        includeNeverSent:
          type:
            - 'null'
            - boolean
        startDate:
          type: string
        endDate:
          type: string
        maxDeliveries:
          type:
            - 'null'
            - integer
          format: int32
      additionalProperties: false
  securitySchemes:
    X-Auth-Token:
      type: apiKey
      description: FlowPayroll JWT (raw token, no Bearer prefix)
      name: X-Auth-Token
      in: header

````

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