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

# Receive a provider event

> Receives signed events from a connected provider. GitHub is the supported provider.

A matching event starts runs for subscribed fleets. Duplicate events do not start another run.




## OpenAPI

````yaml https://raw.githubusercontent.com/agentsfleet/agentsfleet/main/public/openapi.json post /v1/ingress/{provider}
openapi: 3.1.0
info:
  title: agentsfleet Control Plane API
  version: 1.0.0
  description: API for managing workspaces, fleets, triggers, and runs.
  contact:
    name: agentsfleet
    url: https://agentsfleet.net
servers:
  - url: https://api.agentsfleet.net
    description: Production
security:
  - BearerAuth: []
tags:
  - name: Health
    description: System status and readiness probes
    x-mintlify:
      navigation: Health
  - name: Authentication
    description: Command Line Interface (CLI) sign-in sessions and GitHub sign-in
    x-mintlify:
      navigation: Authentication
  - name: Workspaces
    description: Create and manage workspaces
    x-mintlify:
      navigation: Workspaces
  - name: Tenant
    description: Manage tenant provider settings and models
    x-mintlify:
      navigation: Tenant
  - name: auth-identity-events
    description: >-
      Process signed account events from Clerk. This route is not for customer
      fleets.
    x-mintlify:
      navigation: Auth Identity Events
  - name: Fleets
    description: Create, configure, and run fleets
    x-mintlify:
      navigation: Fleets
  - name: Schedules
    description: Manage and receive scheduled Fleet events
    x-mintlify:
      navigation: Schedules
  - name: Memory
    description: Read and search saved fleet memory
    x-mintlify:
      navigation: Memory
  - name: Secrets
    description: Manage named secrets for fleets in a workspace
    x-mintlify:
      navigation: Secrets
  - name: Admin
    description: Manage shared provider keys and models
    x-mintlify:
      navigation: Admin
  - name: Billing
    description: Read tenant balances and charge records
    x-mintlify:
      navigation: Billing
  - name: Integration Grants
    description: Manage fleet access to third-party services
    x-mintlify:
      navigation: Integration Grants
  - name: Connectors
    description: Connect workspaces to third-party providers
    x-mintlify:
      navigation: Connectors
  - name: Fleet Keys
    description: Manage keys that let external clients call a fleet
    x-mintlify:
      navigation: Fleet Keys
  - name: API Keys
    description: Manage tenant admin API keys
    x-mintlify:
      navigation: API Keys
  - name: Webhooks
    description: Receive signed events and approval decisions
    x-mintlify:
      navigation: Webhooks
  - name: Approvals
    description: List, inspect, and resolve pending approvals
    x-mintlify:
      navigation: Approvals
  - name: Fleet
    description: Enroll and manage runners
    x-mintlify:
      navigation: Fleet
  - name: Fleet Bundles
    description: Manage fleet source bundles in a workspace
    x-mintlify:
      navigation: Fleet Bundles
  - name: Fleet library
    description: Browse and add reusable fleet sources
    x-mintlify:
      navigation: Fleet library
  - name: Model Library
    description: List models available to the tenant
    x-mintlify:
      navigation: Model Library
paths:
  /v1/ingress/{provider}:
    post:
      tags:
        - Webhooks
      summary: Receive a provider event
      description: >
        Receives signed events from a connected provider. GitHub is the
        supported provider.


        A matching event starts runs for subscribed fleets. Duplicate events do
        not start another run.
      operationId: ingest_connector_webhook
      parameters:
        - name: provider
          in: path
          required: true
          description: Provider that sent the event.
          schema:
            type: string
            enum:
              - github
        - name: X-GitHub-Event
          in: header
          required: true
          description: >-
            GitHub event type, currently `ping`, `pull_request`, or
            `workflow_run`.
          schema:
            type: string
        - name: X-GitHub-Delivery
          in: header
          required: true
          description: Delivery identifier supplied by GitHub.
          schema:
            type: string
        - name: X-Hub-Signature-256
          in: header
          required: true
          description: >-
            Hash-based Message Authentication Code (HMAC)-SHA256 of the raw
            body, prefixed with `sha256=`.
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              description: >-
                A signed GitHub event body. Events other than `ping` require
                `installation.id` and `repository.full_name`.
              additionalProperties: true
      responses:
        '200':
          description: Valid event that required no fleet run.
          content:
            application/json:
              schema:
                oneOf:
                  - type: object
                    additionalProperties: false
                    required:
                      - status
                    properties:
                      status:
                        type: string
                        x-stability: stable
                        enum:
                          - pong
                          - ignored
                  - type: object
                    additionalProperties: false
                    required:
                      - ignored
                    properties:
                      ignored:
                        type: string
                        x-stability: stable
                        enum:
                          - UZ-WH-021
                          - UZ-WH-022
        '202':
          description: Event matched at least one fleet.
          content:
            application/json:
              schema:
                type: object
                required:
                  - status
                  - matched
                  - enqueued
                properties:
                  status:
                    type: string
                    x-stability: stable
                    enum:
                      - accepted
                  matched:
                    type: integer
                    x-stability: stable
                    minimum: 1
                    maximum: 100
                  enqueued:
                    type: integer
                    x-stability: stable
                    minimum: 0
                    maximum: 100
        '400':
          $ref: '#/components/responses/Error'
        '401':
          $ref: '#/components/responses/Error'
        '404':
          $ref: '#/components/responses/Error'
        '413':
          $ref: '#/components/responses/Error'
        '429':
          description: >-
            This API instance reached its in-flight request ceiling. Retry after
            the advertised delay.
          headers:
            Retry-After:
              description: Seconds before retrying.
              schema:
                type: integer
                minimum: 0
            X-RateLimit-Limit:
              description: Instance in-flight request ceiling.
              schema:
                type: integer
                minimum: 0
            X-RateLimit-Remaining:
              description: Remaining admission capacity, zero for this response.
              schema:
                type: integer
                enum:
                  - 0
            X-RateLimit-Reset:
              description: >-
                Unix timestamp in seconds when immediate retry becomes
                reasonable.
              schema:
                type: integer
                format: int64
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '503':
          $ref: '#/components/responses/Error'
        default:
          $ref: '#/components/responses/Error'
      security: []
components:
  responses:
    Error:
      description: RFC 7807 problem detail error response
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/ErrorBody'
  schemas:
    ErrorBody:
      type: object
      description: RFC 7807 problem detail error response (application/problem+json)
      required:
        - docs_uri
        - title
        - detail
        - error_code
        - request_id
      properties:
        docs_uri:
          type: string
          format: uri
          description: Stable link to documentation for this error code
          example: https://docs.agentsfleet.net/api-reference/error-codes#UZ-AGT-009
        title:
          type: string
          description: Short human-readable label, same for every occurrence of this code
          example: Fleet not found
        detail:
          type: string
          description: Instance-specific context describing what went wrong
          example: No fleet with id 'abc123' in this workspace.
        error_code:
          type: string
          description: Machine-readable error code
          example: UZ-AGT-009
        request_id:
          type: string
          description: Correlation ID for this request
        current_state:
          type: string
          description: >-
            Resource state that blocked the requested change. Present only on
            409 responses.
          example: paused
        user_message:
          type: string
          description: >
            Plain message safe to show to a user. Present only when an error
            defines one.


            Use `detail` or `title` when this field is absent.
          example: >-
            We couldn't find that Fleet. It may have been deleted, or the ID
            doesn't match one in this workspace.
        etag:
          type: string
          description: >-
            Resource version returned on 412 responses so the caller can refetch
            and retry.
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        Obtain a token via the CLI auth flow (POST /v1/auth/sessions) or GitHub
        OAuth

````