AnyHook Events API

openapi: 3.2.0
info:
  title: Anyhook Net Events API
  version: 1.0.0
  description: 'Operations tagged Events across 2 of this provider''s published API definitions: openapi.json, anyhook-net-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://anyhook.net
  description: Management API
- url: https://in.anyhook.net
  description: Ingress (webhook receiver)
security:
- ApiKeyAuth: []
tags:
- name: Events
paths:
  /api/v1/events:
    get:
      operationId: listEvents
      summary: Query event delivery log
      description: Event summaries, newest first, without payloads (fetch one with GET /api/v1/events/{id}). Filter by app_slug, status and limit (1-200, default 50).
      security:
      - ApiKeyAuth: []
      parameters:
      - name: app_slug
        in: query
        schema:
          type: string
      - name: status
        in: query
        schema:
          type: string
          enum:
          - queued
          - success
          - retrying
          - failed
          - rejected
          - circuit_open
          - quota_exceeded
      - name: limit
        in: query
        schema:
          type: integer
          default: 50
          minimum: 1
          maximum: 200
      responses:
        '200':
          description: Event list
          content:
            application/json:
              schema:
                type: object
                properties:
                  events:
                    type: array
                    items:
                      $ref: '#/components/schemas/Event'
                  detail:
                    type: string
                  account_notice:
                    type: object
                    description: 'Present only on a no-account quickstart workspace: its expiry and claim_url.'
        '401':
          description: Unauthorized
      tags:
      - Events
    servers:
    - url: https://anyhook.net
      description: Management API
    - url: https://in.anyhook.net
      description: Ingress (webhook receiver)
  /api/v1/events/{id}/replay:
    post:
      operationId: replayEvent
      summary: Re-deliver a specific event
      description: 'Re-delivers a specific event to its original destination URL.

        Does NOT consume event quota. Use after fixing a downstream error.

        Returns the new event record with is_replay=true.'
      security:
      - ApiKeyAuth: []
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: Replay queued
          content:
            application/json:
              schema:
                type: object
                properties:
                  event:
                    $ref: '#/components/schemas/Event'
        '401':
          description: Unauthorized
        '404':
          description: Event not found
      tags:
      - Events
    servers:
    - url: https://anyhook.net
      description: Management API
    - url: https://in.anyhook.net
      description: Ingress (webhook receiver)
  /api/v1/events/{id}:
    get:
      operationId: getEvent
      summary: Get one event, payload included
      description: One event with its inbound headers and body, and the last delivery response. The body comes back parsed as JSON for reading; replays send the stored bytes unchanged.
      security:
      - ApiKeyAuth: []
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: The event
          content:
            application/json:
              schema:
                type: object
                properties:
                  event:
                    $ref: '#/components/schemas/EventDetail'
        '401':
          description: Unauthorized
        '404':
          description: Event not found
      tags:
      - Events
    servers:
    - url: https://anyhook.net
      description: Management API
    - url: https://in.anyhook.net
      description: Ingress (webhook receiver)
components:
  schemas:
    EventDetail:
      type: object
      description: One event with its payload.
      properties:
        id:
          type: string
        appId:
          type: string
        appName:
          type: string
        source:
          type: string
        eventType:
          type:
          - string
          - 'null'
        status:
          type: string
          enum:
          - queued
          - success
          - retrying
          - failed
          - rejected
          - circuit_open
          - quota_exceeded
        attempt:
          type: integer
        maxAttempts:
          type: integer
        isReplay:
          type: boolean
        replayOf:
          type:
          - string
          - 'null'
        outboundUrl:
          type:
          - string
          - 'null'
        latencyMs:
          type:
          - integer
          - 'null'
        createdAt:
          type: string
          format: date-time
        nextRetryAt:
          type:
          - string
          - 'null'
          format: date-time
        inboundHeaders:
          type:
          - object
          - 'null'
          additionalProperties:
            type: string
        inboundBody:
          type:
          - object
          - 'null'
          description: The inbound body parsed as JSON.
        outboundResponse:
          type:
          - object
          - 'null'
          properties:
            status_code:
              type: integer
            body:
              type: string
            headers:
              type: object
    Event:
      type: object
      description: An event summary, as GET /api/v1/events lists it.
      properties:
        id:
          type: string
        appId:
          type: string
        appName:
          type: string
        source:
          type: string
        eventType:
          type:
          - string
          - 'null'
        status:
          type: string
          enum:
          - queued
          - success
          - retrying
          - failed
          - rejected
          - circuit_open
          - quota_exceeded
        attempt:
          type: integer
        maxAttempts:
          type: integer
        isReplay:
          type: boolean
        replayOf:
          type:
          - string
          - 'null'
        outboundUrl:
          type:
          - string
          - 'null'
        outboundStatus:
          type:
          - integer
          - 'null'
        latencyMs:
          type:
          - integer
          - 'null'
        createdAt:
          type: string
          format: date-time
        nextRetryAt:
          type:
          - string
          - 'null'
          format: date-time
  securitySchemes:
    ApiKeyAuth:
      type: http
      scheme: bearer
      bearerFormat: ahk_live_xxx
      description: 'API key from Dashboard Settings > API Keys. Format: ahk_live_<32 alphanumeric chars>. Example header: Authorization: Bearer ahk_live_a1b2c3...'
x-refined-from:
- openapi.json
- anyhook-net-openapi.json