openapi: 3.2.0
info:
  title: AllFly Connect API
  version: '2026-10-05'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-10-05: 8 operation(s) read from 4 public documentation page(s) (each operation names its page in x-source). This is not the provider''s published contract; AllFly has published no machine-readable contract that the pipeline could find. Engine: local.'
  x-evidence-tiers:
    code-example: 0
    documentation: 8
    pages-with-code: 0
    pages-read: 4
  x-generated-from: documentation
  x-provenance: generated
  x-authored-by: API Evangelist
  x-generated: '2026-10-05'
  x-generator: generate-contract-from-docs.py
  x-engine: local
  x-sources:
  - https://docs.allfly.io/api-key-management
  - https://docs.allfly.io/webhook-integration/consuming-webhooks
  - https://docs.allfly.io/webhook-integration/verifying-signatures
  - https://docs.allfly.io/webhook-integration/faq
security:
- API_Key: []
tags:
- name: Connect
paths:
  /api/connect/v1/webhooks:
    get:
      operationId: get_api_connect_v1_webhooks
      tags:
      - Connect
      summary: Consuming Webhooks
      x-source: https://docs.allfly.io/webhook-integration/consuming-webhooks
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApiConnectV1WebhooksResponse'
      x-evidence:
        kind: documentation
    post:
      operationId: post_api_connect_v1_webhooks
      tags:
      - Connect
      summary: Consuming Webhooks
      x-source: https://docs.allfly.io/webhook-integration/consuming-webhooks
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostApiConnectV1WebhooksRequest'
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostApiConnectV1WebhooksResponse'
      x-evidence:
        kind: documentation
  /api/connect/v1/webhooks/{webhookId}:
    delete:
      operationId: delete_api_connect_v1_webhooks_webhookId
      tags:
      - Connect
      summary: Consuming Webhooks
      x-source: https://docs.allfly.io/webhook-integration/consuming-webhooks
      parameters:
      - name: webhookId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
    get:
      operationId: get_api_connect_v1_webhooks_webhookId
      tags:
      - Connect
      summary: Consuming Webhooks
      x-source: https://docs.allfly.io/webhook-integration/consuming-webhooks
      parameters:
      - name: webhookId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApiConnectV1WebhooksWebhookidResponse'
      x-evidence:
        kind: documentation
    put:
      operationId: put_api_connect_v1_webhooks_webhookId
      tags:
      - Connect
      summary: Consuming Webhooks
      x-source: https://docs.allfly.io/webhook-integration/consuming-webhooks
      parameters:
      - name: webhookId
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PutApiConnectV1WebhooksWebhookidRequest'
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/connect/v1/webhooks/{webhookId}/secret:
    get:
      operationId: get_api_connect_v1_webhooks_webhookId_secret
      tags:
      - Connect
      summary: Consuming Webhooks
      x-source: https://docs.allfly.io/webhook-integration/consuming-webhooks
      parameters:
      - name: webhookId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApiConnectV1WebhooksWebhookidSecretResponse'
      x-evidence:
        kind: documentation
  /api/connect/v1/webhooks/{webhookId}/secret/rotate:
    post:
      operationId: post_api_connect_v1_webhooks_webhookId_secret_rotate
      tags:
      - Connect
      summary: Consuming Webhooks
      x-source: https://docs.allfly.io/webhook-integration/consuming-webhooks
      parameters:
      - name: webhookId
        in: path
        required: true
        schema:
          type: string
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostApiConnectV1WebhooksWebhookidSecretRotateResponse'
      x-evidence:
        kind: documentation
components:
  schemas:
    PostApiConnectV1WebhooksRequest:
      type: object
      properties:
        url:
          type: string
          description: The HTTPS URL we'll POST to.
        event_subscriptions:
          type: string
          description: At least one event type to subscribe to.
        description:
          type: string
          description: A label you can use to keep endpoints organized.
        enabled:
          type: string
          description: Whether we should actually deliver events to this endpoint. Defaults to false.
        headers:
          type: string
          description: Optional static headers to include on every delivery.
      required:
      - url
      - event_subscriptions
    PostApiConnectV1WebhooksWebhookidSecretRotateResponse:
      type: object
      properties:
        key:
          type: string
          description: The new signing secret.
    GetApiConnectV1WebhooksWebhookidResponse:
      type: object
      properties:
        url:
          type: string
          description: The HTTPS URL of the webhook.
        description:
          type: string
          description: Label of the webhook.
        enabled:
          type: string
          description: Whether the webhook is active.
        event_subscriptions:
          type: string
          description: Subscribed event types.
        headers:
          type: string
          description: Static headers configured for the webhook.
    GetApiConnectV1WebhooksWebhookidSecretResponse:
      type: object
      properties:
        key:
          type: string
          description: The endpoint's signing secret.
    PutApiConnectV1WebhooksWebhookidRequest:
      type: object
      properties:
        url:
          type: string
          description: The HTTPS URL we'll POST to.
        event_subscriptions:
          type: string
          description: Event types to subscribe to.
        description:
          type: string
          description: A label you can use to keep endpoints organized.
        enabled:
          type: string
          description: Whether we should actually deliver events to this endpoint.
        headers:
          type: string
          description: Optional static headers to include on every delivery.
    GetApiConnectV1WebhooksResponse:
      type: object
      properties:
        webhooks:
          type: string
          description: All webhooks registered for your organization.
    PostApiConnectV1WebhooksResponse:
      type: object
      properties:
        id:
          type: string
          description: The webhook's id.
  securitySchemes:
    API_Key:
      type: apiKey
      in: header
      name: Authorization
      x-source: https://docs.allfly.io/api-key-management/