AnyHook AnyHook API

openapi: 3.2.0
info:
  title: Anyhook Net AnyHook API
  version: 1.0.0
  description: 'Operations tagged AnyHook API 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: AnyHook API
paths:
  /{user-slug}/{app-slug}:
    post:
      servers:
      - url: https://in.anyhook.net
      operationId: receiveWebhook
      summary: Receive a webhook
      description: 'Receives an inbound webhook from any sender. Answers 200 once the event is durably queued, in about a second; delivery to your destinations is asynchronous. When the app has a source and signing secret set, the sender''s signature is checked here before anything is stored (Stripe-Signature, X-Hub-Signature-256, X-Shopify-Hmac-Sha256, x-line-signature, Standard Webhooks'' webhook-signature and the other schemes listed at https://anyhook.net/docs#sources). A Generic app is not signature-checked. No authentication is required on this endpoint. Only POST is accepted, apart from Meta''s GET hub.mode=subscribe handshake. Browsers can post too: an OPTIONS preflight is answered, every answer carries Access-Control-Allow-Origin: *, and a plain form submitted with ?redirect= set to a page on the form''s own site (its Origin or Referer) is redirected there once the event is stored. Bodies are kept as text: JSON, form-urlencoded and other text bodies are forwarded byte-for-byte, binary bodies and multipart file uploads are not.'
      security: []
      parameters:
      - name: user-slug
        in: path
        required: true
        schema:
          type: string
        description: Your account slug, visible in Dashboard URL and app inbound_url.
      - name: app-slug
        in: path
        required: true
        schema:
          type: string
        description: The app slug returned when creating an app via POST /api/v1/apps.
      responses:
        '200':
          description: Event stored and queued for delivery.
        '202':
          description: 'The app is paused: the request is acknowledged and discarded (body reason `app_inactive`), nothing is stored. A 202 rather than an error keeps the provider from disabling the endpoint.'
        '401':
          description: The sender's signature did not verify. The app's page counts these, and the first 5 a day are kept in the event log as `rejected`, headers and body included.
        '404':
          description: No app at this URL.
        '413':
          description: 'Payload exceeds the plan limit: 512 KB (Free), 2 MB (Pro), 4 MB (Scale).'
        '429':
          description: 'Refused: past the Free plan''s daily cap, or past 12x the monthly quota. Below that ceiling, events past the quota are stored as `quota_exceeded` and replayable.'
        '503':
          description: The event could not be stored (queue and both fallbacks unavailable). Nothing was kept, so the sender's own retry is the safety net.
      tags:
      - AnyHook API
    servers:
    - url: https://anyhook.net
      description: Management API
    - url: https://in.anyhook.net
      description: Ingress (webhook receiver)
components:
  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