Feedback1 Webhooks API

openapi: 3.2.0
info:
  title: Feedback1 Public Webhooks API
  description: '## Feedback1 Public API


    REST API for programmatic access to Feedback1 data.


    ### Authentication


    All endpoints require a Bearer token (API key) in the `Authorization` header:


    ```

    Authorization: Bearer your_api_key_here

    ```


    You can create API keys in the Feedback1 dashboard under Settings > API Keys.


    ### Rate Limits


    - 200 requests per minute per API key

    - Rate limit headers are included in responses


    ### Base URL


    ```

    https://app.feedback1.ai/api/v1

    ```'
  version: 1.0.0
servers:
- url: /api/v1
tags:
- name: Webhooks
  description: Webhook management
paths:
  /webhooks:
    get:
      tags:
      - Webhooks
      summary: List Webhooks
      description: List all webhooks for the current user's tenant.
      operationId: list_webhooks_webhooks_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WebhookList'
      security:
      - HTTPBearer: []
    post:
      tags:
      - Webhooks
      summary: Create Webhook
      description: 'Create a new webhook.


        The webhook secret is only returned once in this response.

        Store it securely for signature verification.'
      operationId: create_webhook_webhooks_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WebhookCreate'
        required: true
      responses:
        '201':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WebhookCreated'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - HTTPBearer: []
  /webhooks/events:
    get:
      tags:
      - Webhooks
      summary: List Webhook Events
      description: List all available webhook event types.
      operationId: list_webhook_events_webhooks_events_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
  /webhooks/{webhook_id}:
    get:
      tags:
      - Webhooks
      summary: Get Webhook
      description: Get webhook details by ID.
      operationId: get_webhook_webhooks__webhook_id__get
      security:
      - HTTPBearer: []
      parameters:
      - name: webhook_id
        in: path
        required: true
        schema:
          type: string
          title: Webhook Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WebhookResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    patch:
      tags:
      - Webhooks
      summary: Update Webhook
      description: Update a webhook.
      operationId: update_webhook_webhooks__webhook_id__patch
      security:
      - HTTPBearer: []
      parameters:
      - name: webhook_id
        in: path
        required: true
        schema:
          type: string
          title: Webhook Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WebhookUpdate'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WebhookResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    delete:
      tags:
      - Webhooks
      summary: Delete Webhook
      description: Delete a webhook.
      operationId: delete_webhook_webhooks__webhook_id__delete
      security:
      - HTTPBearer: []
      parameters:
      - name: webhook_id
        in: path
        required: true
        schema:
          type: string
          title: Webhook Id
      responses:
        '204':
          description: Successful Response
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /webhooks/{webhook_id}/test:
    post:
      tags:
      - Webhooks
      summary: Test Webhook
      description: 'Send a test event to the webhook URL.


        This sends a ''test.ping'' event to verify the webhook is working.'
      operationId: test_webhook_webhooks__webhook_id__test_post
      security:
      - HTTPBearer: []
      parameters:
      - name: webhook_id
        in: path
        required: true
        schema:
          type: string
          title: Webhook Id
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WebhookTestRequest'
              default:
                event_type: test.ping
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WebhookTestResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /webhooks/{webhook_id}/deliveries:
    get:
      tags:
      - Webhooks
      summary: List Webhook Deliveries
      description: List delivery attempts for a webhook.
      operationId: list_webhook_deliveries_webhooks__webhook_id__deliveries_get
      security:
      - HTTPBearer: []
      parameters:
      - name: webhook_id
        in: path
        required: true
        schema:
          type: string
          title: Webhook Id
      - name: page
        in: query
        required: false
        schema:
          type: integer
          default: 1
          title: Page
      - name: page_size
        in: query
        required: false
        schema:
          type: integer
          default: 20
          title: Page Size
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WebhookDeliveryList'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /webhooks/{webhook_id}/rotate-secret:
    post:
      tags:
      - Webhooks
      summary: Rotate Webhook Secret
      description: 'Rotate the webhook secret.


        Generates a new secret. The old secret will immediately stop working.

        Returns the new secret - store it securely!'
      operationId: rotate_webhook_secret_webhooks__webhook_id__rotate_secret_post
      security:
      - HTTPBearer: []
      parameters:
      - name: webhook_id
        in: path
        required: true
        schema:
          type: string
          title: Webhook Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WebhookCreated'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    WebhookDeliveryList:
      properties:
        items:
          items:
            $ref: '#/components/schemas/WebhookDeliveryResponse'
          type: array
          title: Items
        total:
          type: integer
          title: Total
        has_more:
          type: boolean
          title: Has More
      type: object
      required:
      - items
      - total
      - has_more
      title: WebhookDeliveryList
      description: List of webhook deliveries
    WebhookDeliveryResponse:
      properties:
        id:
          type: string
          title: Id
        webhook_id:
          type: string
          title: Webhook Id
        event_type:
          type: string
          title: Event Type
        payload:
          additionalProperties: true
          type: object
          title: Payload
        response_status:
          anyOf:
          - type: integer
          - type: 'null'
          title: Response Status
        response_body:
          anyOf:
          - type: string
          - type: 'null'
          title: Response Body
        duration_ms:
          anyOf:
          - type: integer
          - type: 'null'
          title: Duration Ms
        attempt:
          type: integer
          title: Attempt
        status:
          type: string
          title: Status
        error_message:
          anyOf:
          - type: string
          - type: 'null'
          title: Error Message
        created_at:
          type: string
          format: date-time
          title: Created At
        completed_at:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Completed At
      type: object
      required:
      - id
      - webhook_id
      - event_type
      - payload
      - response_status
      - response_body
      - duration_ms
      - attempt
      - status
      - error_message
      - created_at
      - completed_at
      title: WebhookDeliveryResponse
      description: Webhook delivery attempt details
    WebhookTestResponse:
      properties:
        success:
          type: boolean
          title: Success
        status_code:
          anyOf:
          - type: integer
          - type: 'null'
          title: Status Code
        response_body:
          anyOf:
          - type: string
          - type: 'null'
          title: Response Body
        duration_ms:
          anyOf:
          - type: integer
          - type: 'null'
          title: Duration Ms
        error:
          anyOf:
          - type: string
          - type: 'null'
          title: Error
      type: object
      required:
      - success
      - status_code
      - response_body
      - duration_ms
      - error
      title: WebhookTestResponse
      description: Response from testing a webhook
    WebhookResponse:
      properties:
        id:
          type: string
          title: Id
        name:
          type: string
          title: Name
        url:
          type: string
          title: Url
        events:
          items:
            type: string
          type: array
          title: Events
        product_ids:
          anyOf:
          - items:
              type: string
            type: array
          - type: 'null'
          title: Product Ids
        is_active:
          type: boolean
          title: Is Active
        created_at:
          type: string
          format: date-time
          title: Created At
        updated_at:
          type: string
          format: date-time
          title: Updated At
        last_triggered_at:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Last Triggered At
        failure_count:
          type: integer
          title: Failure Count
      type: object
      required:
      - id
      - name
      - url
      - events
      - product_ids
      - is_active
      - created_at
      - updated_at
      - last_triggered_at
      - failure_count
      title: WebhookResponse
      description: Webhook details (without the secret)
    WebhookTestRequest:
      properties:
        event_type:
          type: string
          title: Event Type
          description: Event type for the test
          default: test.ping
      type: object
      title: WebhookTestRequest
      description: Request to send a test webhook event
    WebhookList:
      properties:
        items:
          items:
            $ref: '#/components/schemas/WebhookResponse'
          type: array
          title: Items
        total:
          type: integer
          title: Total
      type: object
      required:
      - items
      - total
      title: WebhookList
      description: List of webhooks
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    WebhookCreate:
      properties:
        name:
          type: string
          maxLength: 100
          minLength: 1
          title: Name
          description: Name for the webhook
        url:
          type: string
          maxLength: 2083
          minLength: 1
          format: uri
          title: Url
          description: URL to send webhook events to
        events:
          items:
            type: string
          type: array
          minItems: 1
          title: Events
          description: List of events to subscribe to
        product_ids:
          anyOf:
          - items:
              type: string
            type: array
          - type: 'null'
          title: Product Ids
          description: Product IDs to filter events (null = all products)
      type: object
      required:
      - name
      - url
      - events
      title: WebhookCreate
      description: Request to create a new webhook
    WebhookCreated:
      properties:
        id:
          type: string
          title: Id
        name:
          type: string
          title: Name
        url:
          type: string
          title: Url
        secret:
          type: string
          title: Secret
          description: Webhook secret for signature verification - SAVE THIS!
        events:
          items:
            type: string
          type: array
          title: Events
        product_ids:
          anyOf:
          - items:
              type: string
            type: array
          - type: 'null'
          title: Product Ids
        is_active:
          type: boolean
          title: Is Active
        created_at:
          type: string
          format: date-time
          title: Created At
      type: object
      required:
      - id
      - name
      - url
      - secret
      - events
      - product_ids
      - is_active
      - created_at
      title: WebhookCreated
      description: Response after creating a webhook - includes the secret (only shown once!)
    WebhookUpdate:
      properties:
        name:
          anyOf:
          - type: string
            maxLength: 100
            minLength: 1
          - type: 'null'
          title: Name
        url:
          anyOf:
          - type: string
            maxLength: 2083
            minLength: 1
            format: uri
          - type: 'null'
          title: Url
        events:
          anyOf:
          - items:
              type: string
            type: array
          - type: 'null'
          title: Events
        product_ids:
          anyOf:
          - items:
              type: string
            type: array
          - type: 'null'
          title: Product Ids
        is_active:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Is Active
      type: object
      title: WebhookUpdate
      description: Update an existing webhook
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer