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

# Get Webhook Logs

> Show all logs for a webhook

<ResponseExample>
  ```json 200 theme={null}
  {
    "status": "success",
    "total": 1234,
    "page": 2,
    "page_size": 20,
    "data": [
      {
        "webhook_id": 123,
        "event": "transaction",
        "idempotency_key": "a8eb78c3-2b45-4e9e-bf60-9296067fd593",
        "url": "https://api.example.com/webhook",
        "payload": "<any>",
        "successful": true,
        "response_code": 200,
        "error_message": "ConnectionError",
        "created_at": "2024-01-23 01:23:45.55338+00"
      }
    ]
  }
  ```

  ```json 400 theme={null}
  {
    "success": false,
    "error": {
      "issues": [
        {
          "validation": "regex",
          "code": "invalid_string",
          "message": "Invalid",
          "path": [
            "id"
          ]
        }
      ],
      "name": "ZodError"
    }
  }
  ```

  ```JSON 404 theme={null}
  {
    "status": "failed",
    "error": "Webhook not found"
  }
  ```

  ```JSON 500 theme={null}
  {
    "status": "failed",
    "error": "Database operation failed"
  }
  ```
</ResponseExample>


## OpenAPI

````yaml get /webhook/{id}/logs
openapi: 3.0.0
info:
  version: 0.1.0
  title: Openformat API
servers:
  - url: https://api.openformat.tech/v1
    description: Live server
security:
  - ApiKeyAuth: []
paths:
  /webhook/{id}/logs:
    get:
      tags:
        - webhook
        - logs
        - list
      description: Show all logs for a webhook
      parameters:
        - schema:
            type: string
            pattern: ^\d+$
            description: Webhook id
            example: '123'
          required: true
          name: id
          in: path
        - schema:
            type: string
            pattern: ^\d+$
            description: Page to return
            example: '1'
          required: false
          name: page
          in: query
          description: Results page
        - schema:
            type: string
            pattern: ^\d+$
            description: Page size
            example: '20'
          required: false
          name: page_size
          in: query
          description: Page size
      responses:
        '200':
          description: Webhook logs
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    enum:
                      - success
                    description: Successful reponse status
                    example: success
                  total:
                    type: number
                    description: Total amount of logs
                    example: 1234
                  page:
                    type: number
                    description: Current page
                    example: 2
                  page_size:
                    type: number
                    description: Page size
                    example: 20
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        webhook_id:
                          type: number
                          description: Webhook id
                          example: 123
                        event:
                          type: string
                          description: Event name
                          example: transaction
                        idempotency_key:
                          type: string
                          description: Idempotency key for webhook calls
                          example: a8eb78c3-2b45-4e9e-bf60-9296067fd593
                        url:
                          type: string
                          description: Webhook URL
                          example: https://api.example.com/webhook
                        payload:
                          nullable: true
                          description: Webhook payload JSON object
                        successful:
                          type: boolean
                          description: Whether this webhook call was successful
                          example: true
                        response_code:
                          type: number
                          description: Response code received from the webhook
                          example: 200
                        error_message:
                          type: string
                          description: Error when executing the webhook call
                          example: ConnectionError
                        created_at:
                          type: string
                          description: Datetime the webhook call was made
                          example: '2024-01-23 01:23:45.55338+00'
                      required:
                        - webhook_id
                        - event
                        - idempotency_key
                        - url
                        - successful
                        - created_at
                    description: Webhook call logs
                required:
                  - status
                  - total
                  - page
                  - page_size
                  - data
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      issues:
                        type: array
                        items:
                          type: object
                          properties:
                            code:
                              type: string
                              description: Error code for the field
                              example: invalid_type
                            path:
                              type: array
                              items:
                                type: string
                              description: Field with error
                              example:
                                - some_field
                            message:
                              type: string
                              description: Error message
                              example: Required
                          required:
                            - code
                            - path
                            - message
                        description: Error object with all validation issues
                    required:
                      - issues
                required:
                  - error
        '500':
          description: An error ocurred
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    enum:
                      - failed
                    description: Failed reponse status
                    example: failed
                  error:
                    type: string
                    description: Error message
                    example: Database operation failed
                required:
                  - status
                  - error
components:
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-KEY

````