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

# Replay webhook deliveries

> Put the deliveries a broken endpoint left behind back on the wire: every row of this webhook created inside [from, to] whose status is in statuses (default failed and cancelled; success re-fires delivered events, opt-in) goes back to pending, oldest first, scheduled_at one second apart, and the minute tick sends what is due: the stored envelope to the URL stored on the row (a changed target_url is not followed), under the same webhook_log_sid, so the receiver's dedup holds. A cancelled row comes back only when the platform cancelled it, never after a manual cancel (the app's Retry on the row takes that one); rows in flight are never touched; an event emitted while the webhook was off or failed has no row and cannot come back. retry_count stays, so a row that spent its 5 attempts gets one more. from is required; the window spans at most 30 days (422, rule replay_window_too_wide) and one call re-arms at most 5000 rows (429 limit_exceeded): past either nothing is re-armed, narrow from, to, statuses or event_types and call again. Needs status on (409 invalid_transition otherwise): revive a failed webhook with update_webhook first. Throttled 10 a minute per caller, together with test_webhook. Re-delivers real events to the integrator.

Contract:
- MCP tool `replay_webhook`, registry package `mcp.integrations/webhooks`, mount `workspace.webhooks`.
- Operation `action`, response envelope `action`.
- Flags: dangerous: the MCP layer gates it behind a preview/commit token, and the effect cannot be undone through this API.



## OpenAPI

````yaml /api-reference/integrations/openapi.yaml post /api/webhooks/{sid}/replay
openapi: 3.0.3
info:
  title: 'GetSales public contract: gs.service.integrations'
  description: >-
    The integrations service: the integration platform (the team's credentials
    for its own APIs and its CRM grants, the HTTP tools it defines over them,
    the execution log and the priced catalog of every outbound provider call)
    and the event plane (the platform-wide webhook subscriptions and the
    delivery state of each event).


    GENERATED. This document is projected from the Zod MCP tool registry in
    `product/mcp/gs.mcp` (one tool per public endpoint, 1:1). Do not edit it by
    hand; edit the tool definition and regenerate with `pnpm openapi:public`.


    Surface: the public `/api` contract of `gs.service.integrations`, 26
    operations. This is the only OpenAPI document the platform publishes.
    Internal (`/internal`) and health endpoints are deliberately absent: they
    are not part of any contract, they can change without notice, and the
    service source is their only description.


    Conventions:

    - Auth is a bearer JWT, optionally narrowed by the `Team-SID` header.

    - Every success body is an MCP envelope: `success: true` plus one typed
    `operation` shape (`search`, `get`, `create`, `update`, `delete`, `metrics`,
    `group_by`, `action`), and a `meta` block with `trace_id` for support.

    - Every failure is the same `McpError` envelope with a code from a fixed
    16-code taxonomy, so a client maps errors once.

    - Lists page with `page_size` (0 to 500, default 50) plus an opaque forward
    `cursor`; `page_size: 0` returns counts only.

    - On `GET` and `DELETE`, object-valued query parameters (`filter`, `sort`)
    travel as JSON text and array-valued ones repeat as `name[]=value`.

    - The MCP-only `_meta` field (usage analytics) never reaches the backend and
    is not part of this contract.
  version: '1.0'
  contact:
    name: GetSales
    url: https://getsales.io
    email: support@getsales.io
  license:
    name: Proprietary
    url: https://getsales.io/terms
servers:
  - url: https://api2.getsales.io/integrations/v1
    description: Production
security:
  - BearerJwt: []
    TeamSid: []
tags:
  - name: custom_tools
    description: >-
      Registry package `mcp.integrations/custom_tools`, served on MCP mount
      `workspace.integrations`.
  - name: provider_calls
    description: >-
      Registry package `mcp.integrations/provider_calls`, served on MCP mount
      `workspace.integrations`.
  - name: provider_connections
    description: >-
      Registry package `mcp.integrations/provider_connections`, served on MCP
      mount `workspace.integrations`.
  - name: webhook_logs
    description: >-
      Registry package `mcp.integrations/webhook_logs`, served on MCP mount
      `workspace.webhooks`.
  - name: webhooks
    description: >-
      Registry package `mcp.integrations/webhooks`, served on MCP mount
      `workspace.webhooks`.
paths:
  /api/webhooks/{sid}/replay:
    post:
      tags:
        - webhooks
      summary: Replay webhook deliveries
      description: >-
        Put the deliveries a broken endpoint left behind back on the wire: every
        row of this webhook created inside [from, to] whose status is in
        statuses (default failed and cancelled; success re-fires delivered
        events, opt-in) goes back to pending, oldest first, scheduled_at one
        second apart, and the minute tick sends what is due: the stored envelope
        to the URL stored on the row (a changed target_url is not followed),
        under the same webhook_log_sid, so the receiver's dedup holds. A
        cancelled row comes back only when the platform cancelled it, never
        after a manual cancel (the app's Retry on the row takes that one); rows
        in flight are never touched; an event emitted while the webhook was off
        or failed has no row and cannot come back. retry_count stays, so a row
        that spent its 5 attempts gets one more. from is required; the window
        spans at most 30 days (422, rule replay_window_too_wide) and one call
        re-arms at most 5000 rows (429 limit_exceeded): past either nothing is
        re-armed, narrow from, to, statuses or event_types and call again. Needs
        status on (409 invalid_transition otherwise): revive a failed webhook
        with update_webhook first. Throttled 10 a minute per caller, together
        with test_webhook. Re-delivers real events to the integrator.


        Contract:

        - MCP tool `replay_webhook`, registry package
        `mcp.integrations/webhooks`, mount `workspace.webhooks`.

        - Operation `action`, response envelope `action`.

        - Flags: dangerous: the MCP layer gates it behind a preview/commit
        token, and the effect cannot be undone through this API.
      operationId: replay_webhook
      parameters:
        - name: sid
          in: path
          required: true
          description: Webhook sid (wh_hk_...).
          schema:
            type: string
            minLength: 18
            maxLength: 18
            pattern: ^wh_hk_
            description: Webhook sid (wh_hk_...).
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ReplayWebhookRequest'
      responses:
        '200':
          description: '`action` success envelope.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReplayWebhookResponse'
        4XX:
          $ref: '#/components/responses/McpClientError'
        5XX:
          $ref: '#/components/responses/McpServerError'
components:
  schemas:
    ReplayWebhookRequest:
      type: object
      description: Request body of `replay_webhook`.
      properties:
        from:
          type: string
          description: >-
            ISO 8601: the oldest created_at to re-arm. Required: a replay
            re-fires real deliveries, so the caller names how far back it goes.
        to:
          type: string
          nullable: true
          description: ISO 8601; default now.
        statuses:
          type: array
          items:
            type: string
            enum:
              - failed
              - cancelled
              - success
          minItems: 1
          description: Default failed and cancelled; success is opt-in.
        event_types:
          type: array
          items:
            type: string
            enum:
              - data-sources.completed
              - data-sources.failed
              - data-sources.paused
              - data-sources.deleted
              - playtable-runs.finished
              - playtable-runs.cancelled
              - workflows.published
              - workflow-records.entered
              - workflow-records.completed
              - workflow-records.failed
              - workflow-records.exited
              - workflow-records.paused
              - workflow-records.resumed
              - messages.sent
              - messages.received
              - messages.bounced
              - conversations.created
              - conversations.state-changed
              - conversations.scenario-changed
              - conversations.merged
              - conversations.person-linked
              - conversations.person-unlinked
              - conversations.signals-changed
              - tasks.created
              - tasks.completed
              - sender-profiles.created
              - sender-profiles.deleted
              - sender-profiles.health-changed
              - agents.mode-changed
              - signals.website-visited
              - website-sites.broken
              - website-sites.recovered
              - webhooks.failed
          minItems: 1
          description: Default every type.
      required:
        - from
    ReplayWebhookResponse:
      type: object
      properties:
        success:
          type: boolean
          enum:
            - true
        operation:
          type: string
          enum:
            - action
        action:
          type: string
          description: kebab-case verb; matches the route segment.
        item:
          type: object
          nullable: true
          properties:
            sid:
              type: string
              description: Webhook sid (wh_hk_...).
            team_sid:
              type: string
              description: The subscribing workspace (ts_tm_...).
            name:
              type: string
              description: Free text, 1..255 chars.
            target_url:
              type: string
              description: >-
                The https endpoint events are POSTed to; one subscription per
                team per URL.
            events:
              type: array
              items:
                type: string
              description: >-
                The subscribed event types (WebhookEventTypeEnum values), exact
                membership; exactly ["*"] = every catalog event, later ones
                included.
            filters:
              type: object
              nullable: true
              properties:
                account_sid:
                  type: string
                  nullable: true
                  description: >-
                    The sender profile the subscription is narrowed to
                    (ub_sp_...); null = none.
                where:
                  type: object
                  nullable: true
                  additionalProperties: {}
                  description: The payload gate as stored (FilterAst); null = none.
              description: >-
                The narrowing by sender profile and the payload gate; both
                members null = every subscribed event.
            secret:
              type: string
              nullable: true
              description: >-
                The 32-hex HMAC secret: in the create response only, null on
                every other read.
            status:
              type: string
              enum:
                - 'on'
                - 'off'
                - failed
              description: >-
                on; off (switched off by hand); failed (20 failed attempts in a
                row or one 410: revive with update status on).
            consecutive_failed_attempts:
              type: integer
              description: >-
                Failed attempts in a row, driven by the log; 20 trips the
                auto-disable, and the count freezes once the subscription is not
                on.
            last_failure_at:
              type: string
              nullable: true
              description: >-
                ISO 8601 UTC of the latest failed attempt of the current streak:
                a delivered event and a revive clear it, a 410 does not set it.
            created_by:
              type: object
              properties:
                actor_type:
                  type: string
                  enum:
                    - user
                    - support
                    - api_key
                    - system
                    - agent
                actor_sid:
                  type: string
                  nullable: true
                team_sid:
                  type: string
                actor_name:
                  type: string
                  nullable: true
                  description: >-
                    The OAuth client that acted ("Claude", "n8n"); null for a
                    user, an API key or a system job.
                oauth_client_sid:
                  type: string
                  nullable: true
                  description: The acting OAuth client (id_oc_*); null off the OAuth path.
                reason:
                  type: string
                  nullable: true
                  description: >-
                    Why a system actor wrote the row (snapshot_capture_job,
                    ...); null otherwise.
                permissions:
                  type: object
                  additionalProperties: {}
                  description: >-
                    Internal audit context: the grant set the actor held at
                    write time. Not a contract.
                cluster_id:
                  type: integer
                  nullable: true
                  description: 'Internal audit context: the cluster that served the write.'
                trace_id:
                  type: string
                  nullable: true
                  description: >-
                    Internal audit context: the trace id of the request that
                    wrote the row.
              required:
                - actor_type
                - actor_sid
                - team_sid
                - permissions
              description: Who subscribed.
            deleted_by:
              type: object
              nullable: true
              properties:
                actor_type:
                  type: string
                  enum:
                    - user
                    - support
                    - api_key
                    - system
                    - agent
                actor_sid:
                  type: string
                  nullable: true
                team_sid:
                  type: string
                actor_name:
                  type: string
                  nullable: true
                  description: >-
                    The OAuth client that acted ("Claude", "n8n"); null for a
                    user, an API key or a system job.
                oauth_client_sid:
                  type: string
                  nullable: true
                  description: The acting OAuth client (id_oc_*); null off the OAuth path.
                reason:
                  type: string
                  nullable: true
                  description: >-
                    Why a system actor wrote the row (snapshot_capture_job,
                    ...); null otherwise.
                permissions:
                  type: object
                  additionalProperties: {}
                  description: >-
                    Internal audit context: the grant set the actor held at
                    write time. Not a contract.
                cluster_id:
                  type: integer
                  nullable: true
                  description: 'Internal audit context: the cluster that served the write.'
                trace_id:
                  type: string
                  nullable: true
                  description: >-
                    Internal audit context: the trace id of the request that
                    wrote the row.
              required:
                - actor_type
                - actor_sid
                - team_sid
                - permissions
              description: >-
                Who deleted it; null while live, and on a row deleted before
                2026-11-04.
            created_at:
              type: string
              description: ISO 8601 UTC.
            updated_at:
              type: string
              description: ISO 8601 UTC.
            deleted_at:
              type: string
              nullable: true
              description: ISO 8601 UTC; null = live.
          required:
            - sid
            - team_sid
            - name
            - target_url
            - events
            - filters
            - status
            - consecutive_failed_attempts
            - last_failure_at
            - created_by
            - deleted_by
            - created_at
            - updated_at
            - deleted_at
        result:
          type: object
          properties:
            rows:
              type: integer
              description: Deliveries re-armed by this call.
            from:
              type: string
              description: The window's start as applied, ISO 8601 UTC.
            to:
              type: string
              description: The window's end as applied, ISO 8601 UTC.
            statuses:
              type: array
              items:
                type: string
                enum:
                  - failed
                  - cancelled
                  - success
              description: The outcomes re-armed, defaults filled in.
            first_scheduled_at:
              type: string
              nullable: true
              description: ISO 8601 UTC of the first re-armed row; null when rows is 0.
            last_scheduled_at:
              type: string
              nullable: true
              description: >-
                When the last re-armed row falls due: rows - 1 seconds after
                first_scheduled_at; the next minute tick sends it.
          required:
            - rows
            - from
            - to
            - statuses
            - first_scheduled_at
            - last_scheduled_at
        meta:
          type: object
          properties:
            trace_id:
              type: string
              description: UUID v7; same 128-bit value as the X-Trace-Id header.
            span_id:
              type: string
              pattern: ^[0-9a-f]{16}$
              description: 16 hex chars, root span of this request.
            timestamp:
              type: string
              description: ISO 8601 UTC (Y-m-dTH:i:sZ), response time.
            duration_ms:
              type: integer
              minimum: 0
              description: Server-side wall clock.
            team_sid:
              type: string
              nullable: true
              description: >-
                The team this call ran in (the token team, or the team_sid
                override). Null when unauthenticated; absent from pre-2026-08-20
                backends.
            actor_type:
              type: string
              nullable: true
              description: >-
                user | agent | api_key | system. Null when unauthenticated;
                absent from pre-2026-08-20 backends.
          required:
            - trace_id
            - span_id
            - timestamp
            - duration_ms
      required:
        - success
        - operation
        - action
        - item
        - result
        - meta
    McpError:
      type: object
      properties:
        success:
          type: boolean
          enum:
            - false
        error:
          type: object
          properties:
            code:
              type: string
              enum:
                - validation_failed
                - nothing_to_update
                - not_found
                - relation_not_found
                - invalid_transition
                - limit_exceeded
                - payment_required
                - duplicate_rejected
                - conflict
                - delete_blocked
                - unauthorized
                - forbidden
                - rate_limited
                - internal_error
                - service_unavailable
                - not_implemented
            message:
              type: string
            recoverable:
              type: boolean
            suggestion:
              type: string
            field_errors:
              type: object
              additionalProperties:
                type: array
                items:
                  type: object
                  properties:
                    rule:
                      type: string
                    message:
                      type: string
                  required:
                    - rule
                    - message
            blockers:
              type: array
              items:
                type: object
                properties:
                  type:
                    type: string
                    description: >-
                      Machine-readable blocker type (active_flow, pending_tasks,
                      …).
                  severity:
                    type: string
                    enum:
                      - hard
                      - soft
                    description: >-
                      hard = external action required; soft = acknowledge is
                      enough.
                  description:
                    type: string
                  entity_sid:
                    type: string
                    nullable: true
                  count:
                    type: integer
                  resolution:
                    type: string
                    description: 'Hard: tool name to call. Soft: code for acknowledge[].'
                  resolution_hint:
                    type: string
                required:
                  - type
                  - severity
                  - description
                  - entity_sid
                  - resolution
                  - resolution_hint
            context:
              type: object
              additionalProperties: {}
          required:
            - code
            - message
            - recoverable
        meta:
          type: object
          properties:
            trace_id:
              type: string
              description: UUID v7; same 128-bit value as the X-Trace-Id header.
            span_id:
              type: string
              pattern: ^[0-9a-f]{16}$
              description: 16 hex chars, root span of this request.
            timestamp:
              type: string
              description: ISO 8601 UTC (Y-m-dTH:i:sZ), response time.
            duration_ms:
              type: integer
              minimum: 0
              description: Server-side wall clock.
            team_sid:
              type: string
              nullable: true
              description: >-
                The team this call ran in (the token team, or the team_sid
                override). Null when unauthenticated; absent from pre-2026-08-20
                backends.
            actor_type:
              type: string
              nullable: true
              description: >-
                user | agent | api_key | system. Null when unauthenticated;
                absent from pre-2026-08-20 backends.
          required:
            - trace_id
            - span_id
            - timestamp
            - duration_ms
      required:
        - success
        - error
  responses:
    McpClientError:
      description: >-
        MCP error envelope. `error.code` is one of validation_failed,
        nothing_to_update, not_found, relation_not_found, invalid_transition,
        limit_exceeded, payment_required, duplicate_rejected, conflict,
        delete_blocked, unauthorized, forbidden, rate_limited, not_implemented.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/McpError'
    McpServerError:
      description: >-
        MCP error envelope with `error.code` internal_error or
        service_unavailable.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/McpError'
  securitySchemes:
    BearerJwt:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        Access token issued by gs.service.id. Its `access_identity` claim
        carries `team_sid`, `actor_sid` and `actor_type`, and that team scope is
        authoritative.
    TeamSid:
      type: apiKey
      in: header
      name: Team-SID
      description: >-
        Team scope for tokens that do not carry one. Ignored when the token
        already names a team.

````

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