> ## 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.

# Search webhook logs

> The deliveries of the team's webhooks, one row per event per subscription, from every producing service: per webhook, per sending identity, per event type, per status or response code; include webhook. The auditing and outage-debugging read (why did the integrator not get the event). Period-bound success rates are get_webhook_logs_metrics. page_size 0 returns the counts only.

Contract:
- MCP tool `search_webhook_logs`, registry package `mcp.integrations/webhook_logs`, mount `integrations.webhooks`.
- Operation `search`, response envelope `search`.
- Flags: read only.



## OpenAPI

````yaml /api-reference/integrations/openapi.yaml post /api/webhook-logs/search
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://beta.getsales.io/integrations/v1
    description: >-
      Production (the gateway path on the beta ring; the origin is provisioned
      per DEPLOY_MAP.md)
security:
  - BearerJwt: []
    TeamSid: []
tags:
  - name: custom_tools
    description: >-
      Registry package `mcp.integrations/custom_tools`, served on MCP mount
      `integrations.providers`.
  - name: provider_calls
    description: >-
      Registry package `mcp.integrations/provider_calls`, served on MCP mount
      `integrations.providers`.
  - name: provider_connections
    description: >-
      Registry package `mcp.integrations/provider_connections`, served on MCP
      mount `integrations.providers`.
  - name: webhook_logs
    description: >-
      Registry package `mcp.integrations/webhook_logs`, served on MCP mount
      `integrations.webhooks`.
  - name: webhooks
    description: >-
      Registry package `mcp.integrations/webhooks`, served on MCP mount
      `integrations.webhooks`.
paths:
  /api/webhook-logs/search:
    post:
      tags:
        - webhook_logs
      summary: Search webhook logs
      description: >-
        The deliveries of the team's webhooks, one row per event per
        subscription, from every producing service: per webhook, per sending
        identity, per event type, per status or response code; include webhook.
        The auditing and outage-debugging read (why did the integrator not get
        the event). Period-bound success rates are get_webhook_logs_metrics.
        page_size 0 returns the counts only.


        Contract:

        - MCP tool `search_webhook_logs`, registry package
        `mcp.integrations/webhook_logs`, mount `integrations.webhooks`.

        - Operation `search`, response envelope `search`.

        - Flags: read only.
      operationId: search_webhook_logs
      requestBody:
        required: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SearchWebhookLogsRequest'
      responses:
        '200':
          description: '`search` success envelope.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SearchWebhookLogsResponse'
        4XX:
          $ref: '#/components/responses/McpClientError'
        5XX:
          $ref: '#/components/responses/McpServerError'
components:
  schemas:
    SearchWebhookLogsRequest:
      type: object
      description: Request body of `search_webhook_logs`.
      properties:
        filter:
          type: object
          properties:
            sid:
              type: object
              properties:
                eq:
                  type: string
                in:
                  type: array
                  items:
                    type: string
              additionalProperties: false
              description: Delivery sid(s).
            webhook_sid:
              type: object
              properties:
                eq:
                  type: string
                in:
                  type: array
                  items:
                    type: string
              additionalProperties: false
              description: One subscription's deliveries.
            account_sid:
              type: object
              properties:
                eq:
                  type: string
                in:
                  type: array
                  items:
                    type: string
                is_null:
                  type: boolean
              additionalProperties: false
              description: One sending identity; is_null true = team-wide events.
            source_service:
              type: object
              properties:
                eq:
                  type: string
                in:
                  type: array
                  items:
                    type: string
              additionalProperties: false
              description: playtables | unibox | signals | integrations.
            event_type:
              type: object
              properties:
                eq:
                  type: string
                ne:
                  type: string
                in:
                  type: array
                  items:
                    type: string
                nin:
                  type: array
                  items:
                    type: string
              additionalProperties: false
              description: The event type.
            event_source_sid:
              type: object
              properties:
                eq:
                  type: string
                in:
                  type: array
                  items:
                    type: string
              additionalProperties: false
              description: The row that produced the event.
            status:
              type: object
              properties:
                eq:
                  type: string
                  enum:
                    - pending
                    - in_progress
                    - retrying
                    - success
                    - failed
                    - cancelled
                ne:
                  type: string
                  enum:
                    - pending
                    - in_progress
                    - retrying
                    - success
                    - failed
                    - cancelled
                in:
                  type: array
                  items:
                    type: string
                    enum:
                      - pending
                      - in_progress
                      - retrying
                      - success
                      - failed
                      - cancelled
                nin:
                  type: array
                  items:
                    type: string
                    enum:
                      - pending
                      - in_progress
                      - retrying
                      - success
                      - failed
                      - cancelled
              additionalProperties: false
              description: in [pending, retrying] = still in flight.
            cancel_reason:
              type: object
              properties:
                eq:
                  type: string
                  enum:
                    - manual
                    - webhook_deleted
                    - webhook_disabled
                    - webhook_failed
                in:
                  type: array
                  items:
                    type: string
                    enum:
                      - manual
                      - webhook_deleted
                      - webhook_disabled
                      - webhook_failed
                is_null:
                  type: boolean
              additionalProperties: false
              description: Why a row was cancelled.
            retry_count:
              type: object
              properties:
                eq:
                  type: number
                ne:
                  type: number
                gte:
                  type: number
                lte:
                  type: number
                gt:
                  type: number
                lt:
                  type: number
              additionalProperties: false
              description: Executed attempts.
            response_code:
              type: object
              properties:
                eq:
                  type: number
                ne:
                  type: number
                gte:
                  type: number
                lte:
                  type: number
                gt:
                  type: number
                lt:
                  type: number
                is_null:
                  type: boolean
              additionalProperties: false
              description: is_null true = no HTTP answer (network, timeout).
            duration_ms:
              type: object
              properties:
                eq:
                  type: number
                ne:
                  type: number
                gte:
                  type: number
                lte:
                  type: number
                gt:
                  type: number
                lt:
                  type: number
                is_null:
                  type: boolean
              additionalProperties: false
              description: The last attempt's latency.
            scheduled_at:
              type: object
              properties:
                gte:
                  type: string
                lte:
                  type: string
                gt:
                  type: string
                lt:
                  type: string
              additionalProperties: false
              description: ISO 8601 bounds.
            executed_at:
              type: object
              properties:
                gte:
                  type: string
                lte:
                  type: string
                gt:
                  type: string
                lt:
                  type: string
                is_null:
                  type: boolean
              additionalProperties: false
              description: ISO 8601 bounds; is_null true = never attempted.
            created_at:
              type: object
              properties:
                gte:
                  type: string
                lte:
                  type: string
                gt:
                  type: string
                lt:
                  type: string
              additionalProperties: false
              description: ISO 8601 bounds.
          description: >-
            Field filters, ANDed: {field: {eq | ne | in | nin | gte | lte | gt |
            lt | is_null}}; q inside it is free text. Omit for every row.
        include:
          type: array
          items:
            type: string
            enum:
              - webhook
          description: Relations to attach to every item; omit for the bare rows.
        sort:
          type: object
          properties:
            field:
              type: string
              enum:
                - created_at
                - scheduled_at
                - executed_at
                - duration_ms
              description: The column to order by.
            direction:
              type: string
              enum:
                - asc
                - desc
              description: asc or desc; default desc.
          required:
            - field
          description: One column and its direction; omit for the default order.
        page_size:
          type: integer
          minimum: 0
          maximum: 500
          description: 0..500, default 50; 0 = counts only, 1 = the first row.
        cursor:
          type: string
          nullable: true
          description: pagination.next_cursor of the previous page.
    SearchWebhookLogsResponse:
      type: object
      properties:
        success:
          type: boolean
          enum:
            - true
        operation:
          type: string
          enum:
            - search
        items:
          type: array
          items:
            type: object
            properties:
              item:
                type: object
                properties:
                  sid:
                    type: string
                    description: Delivery sid (wh_lg_...).
                  team_sid:
                    type: string
                    description: The subscribing workspace (ts_tm_...).
                  webhook_sid:
                    type: string
                    description: The parent subscription (wh_hk_...).
                  account_sid:
                    type: string
                    nullable: true
                    description: >-
                      The sending identity the subscription matched on
                      (ub_sp_...); null on a team-wide event.
                  source_service:
                    type: string
                    nullable: true
                    description: >-
                      Which service produced the event (playtables, unibox,
                      signals, integrations); observability only.
                  event_type:
                    type: string
                    description: The event type (a WebhookEventTypeEnum value).
                  event_source_sid:
                    type: string
                    nullable: true
                    description: >-
                      The row whose state change produced the event; null when
                      none.
                  status:
                    type: string
                    enum:
                      - pending
                      - in_progress
                      - retrying
                      - success
                      - failed
                      - cancelled
                    description: >-
                      pending or retrying = waiting for the tick; in_progress =
                      leased by a worker; success; failed (the ladder ran out,
                      or a 4xx); cancelled.
                  retry_count:
                    type: integer
                    description: Executed attempts; a manual re-arm does not move it.
                  cancel_reason:
                    type: string
                    nullable: true
                    enum:
                      - manual
                      - webhook_deleted
                      - webhook_disabled
                      - webhook_failed
                    description: >-
                      manual, or the cascade of a deleted, disabled or failed
                      webhook; null unless cancelled.
                  request_method:
                    type: string
                    enum:
                      - POST
                    description: POST.
                  request_url:
                    type: string
                    description: 'The target URL at insert: a retry replays it.'
                  request_headers:
                    type: object
                    additionalProperties:
                      type: string
                    description: The X-Webhook-* and X-Trace-Id headers as sent.
                  request_payload:
                    type: object
                    properties:
                      webhook_log_sid:
                        type: string
                        description: 'This row''s own sid: the receiver''s dedup key.'
                      type:
                        type: string
                        description: The event type (a WebhookEventTypeEnum value).
                      emitted_at:
                        type: string
                        description: ISO 8601 UTC of the state change.
                      team_sid:
                        type: string
                        description: The workspace (ts_tm_...).
                      trace_id:
                        type: string
                        description: The trace of the write that produced the event.
                      payload:
                        type: object
                        additionalProperties: {}
                        description: The event-specific payload.
                    required:
                      - webhook_log_sid
                      - type
                      - emitted_at
                      - team_sid
                      - trace_id
                      - payload
                    description: The stored envelope.
                  response_code:
                    type: integer
                    nullable: true
                    description: The receiver's status; null on a network error.
                  error_message:
                    type: string
                    nullable: true
                    description: The last attempt's error.
                  duration_ms:
                    type: integer
                    nullable: true
                    description: The last attempt's wall clock; null before one ran.
                  scheduled_at:
                    type: string
                    description: ISO 8601 UTC when the next (or last) attempt is due.
                  executed_at:
                    type: string
                    nullable: true
                    description: ISO 8601 UTC of the last attempt; null before one ran.
                  created_at:
                    type: string
                    description: ISO 8601 UTC.
                  updated_at:
                    type: string
                    description: ISO 8601 UTC.
                required:
                  - sid
                  - team_sid
                  - webhook_sid
                  - account_sid
                  - source_service
                  - event_type
                  - event_source_sid
                  - status
                  - retry_count
                  - cancel_reason
                  - request_method
                  - request_url
                  - request_headers
                  - request_payload
                  - response_code
                  - error_message
                  - duration_ms
                  - scheduled_at
                  - executed_at
                  - created_at
                  - updated_at
              included:
                type: object
                properties:
                  webhook:
                    type: object
                    additionalProperties: {}
                    description: The parent subscription (WebhookDomain, secret masked).
            required:
              - item
              - included
        pagination:
          type: object
          properties:
            next_cursor:
              type: string
              nullable: true
            has_more:
              type: boolean
            total_count:
              type: integer
              nullable: true
          required:
            - next_cursor
            - has_more
            - total_count
        applied_filters:
          type: object
          additionalProperties: {}
        includes:
          type: array
          items:
            type: string
        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
        counts:
          type: object
          properties:
            total_count:
              type: number
              description: Deliveries matching the filter.
            groups:
              type: object
              additionalProperties: {}
              description: >-
                status, event_type, response_code, webhook_sid, account_sid: the
                count per value.
          required:
            - total_count
            - groups
      required:
        - success
        - operation
        - items
        - pagination
        - applied_filters
        - includes
        - 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.