ayhire-com

ayhire-com Integrations API

Workspace webhooks and the workspace's ATS.

GitHub OpenAPI

Operations 13

GET /api/integrations/ats The workspace's ATS #
PUT /api/integrations/ats Connect an ATS #
PATCH /api/integrations/ats Change how people go to the ATS #
DELETE /api/integrations/ats Forget the ATS key #
GET /api/integrations/ats/jobs The connected ATS's open jobs #
GET /api/integrations/webhooks The workspace's webhooks #
POST /api/integrations/webhooks Add a webhook #
PATCH /api/integrations/webhooks/{id} Change a webhook #
DELETE /api/integrations/webhooks/{id} Delete a webhook #
GET /api/integrations/webhooks/{id}/deliveries A webhook's last deliveries, newest first #
POST /api/integrations/webhooks/{id}/deliveries/{delivery}/resend Send a delivery again #
POST /api/integrations/webhooks/{id}/rotate A new signing secret #
POST /api/integrations/webhooks/{id}/test Send a signed ping now #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/ayhire-com/openapi/ayhire-com-integrations-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/ayhire-com/json-schema/ayhire-com-repository-knowledge-schema.json
📊
JSONSchema
https://artifacts.apis.io/ayhire-com/json-schema/ayhire-com-role-funnel-schema.json
📊
JSONSchema
https://artifacts.apis.io/ayhire-com/json-schema/ayhire-com-outcome-event-schema.json
📊
JSONSchema
https://artifacts.apis.io/ayhire-com/json-schema/ayhire-com-scraped-candidate-schema.json
📊
JSONSchema
https://artifacts.apis.io/ayhire-com/json-schema/ayhire-com-role-person-schema.json
📊
JSONSchema
https://artifacts.apis.io/ayhire-com/json-schema/ayhire-com-watch-schema.json

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/ayhire-com:ayhire-com-integrations-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

ayhire-com-integrations-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Ayhire Com Integrations API
  version: 1.0.0
  contact:
    name: AyHire
    url: https://ayhire.com
  description: 'Operations tagged Integrations across 2 of this provider''s published API definitions: ayhire-com-openapi.json, ayhire-com-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://ayhire.com
security:
- bearerAuth: []
- apiKeyHeader: []
tags:
- name: Integrations
  description: Workspace webhooks and the workspace's ATS.
paths:
  /api/integrations/ats:
    get:
      operationId: getAts
      summary: The workspace's ATS
      description: Nobody ever gets a key back.
      tags:
      - Integrations
      parameters:
      - name: workspace
        in: query
        description: Which of your workspaces, by id or name. The current one when left out.
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  configured:
                    type: boolean
                  workspace:
                    type: object
                    properties:
                      id:
                        type: string
                        format: uuid
                      name:
                        type: string
                      personal:
                        type: boolean
                  can_manage:
                    type: boolean
                  connection:
                    oneOf:
                    - $ref: '#/components/schemas/AtsConnection'
                    - type: 'null'
                  providers:
                    type: array
                    items:
                      type: object
                      properties: {}
                    description: The ATSs AyHire connects to, with the fields each needs
                required:
                - connection
                - providers
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          $ref: '#/components/responses/ServerError'
    put:
      operationId: connectAts
      summary: Connect an ATS
      description: Owners only. Checks the key with the ATS, then keeps it.
      tags:
      - Integrations
      parameters:
      - name: workspace
        in: query
        description: Which of your workspaces, by id or name. The current one when left out.
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                provider:
                  type: string
                  minLength: 2
                  maxLength: 32
                fields:
                  type: object
                  additionalProperties:
                    type: string
                    maxLength: 2000
              required:
              - provider
              - fields
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  connection:
                    $ref: '#/components/schemas/AtsConnection'
                required:
                - connection
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          $ref: '#/components/responses/ServerError'
    patch:
      operationId: updateAts
      summary: Change how people go to the ATS
      description: Owners only.
      tags:
      - Integrations
      parameters:
      - name: workspace
        in: query
        description: Which of your workspaces, by id or name. The current one when left out.
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                auto_send:
                  type: boolean
                  description: Send each shortlisted person
                default_job:
                  oneOf:
                  - type: object
                    properties:
                      id:
                        type: string
                        minLength: 1
                        maxLength: 200
                      title:
                        type: string
                        maxLength: 200
                    required:
                    - id
                    - title
                  - type: 'null'
              minProperties: 1
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  connection:
                    $ref: '#/components/schemas/AtsConnection'
                required:
                - connection
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          $ref: '#/components/responses/ServerError'
    delete:
      operationId: disconnectAts
      summary: Forget the ATS key
      description: Owners only.
      tags:
      - Integrations
      parameters:
      - name: workspace
        in: query
        description: Which of your workspaces, by id or name. The current one when left out.
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  removed:
                    type: boolean
                required:
                - removed
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          $ref: '#/components/responses/ServerError'
    servers:
    - url: https://ayhire.com
  /api/integrations/ats/jobs:
    get:
      operationId: listAtsJobs
      summary: The connected ATS's open jobs
      tags:
      - Integrations
      parameters:
      - name: workspace
        in: query
        description: Which of your workspaces, by id or name. The current one when left out.
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  jobs:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          minLength: 1
                          maxLength: 200
                        title:
                          type: string
                          maxLength: 200
                      required:
                      - id
                      - title
                required:
                - jobs
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          $ref: '#/components/responses/ServerError'
    servers:
    - url: https://ayhire.com
  /api/integrations/webhooks:
    get:
      operationId: listWebhooks
      summary: The workspace's webhooks
      description: Members see each address cut to its host. Nobody gets a secret back.
      tags:
      - Integrations
      parameters:
      - name: workspace
        in: query
        description: Which of your workspaces, by id or name. The current one when left out.
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  workspace:
                    type: object
                    properties:
                      id:
                        type: string
                        format: uuid
                      name:
                        type: string
                      personal:
                        type: boolean
                  can_manage:
                    type: boolean
                  max:
                    type: integer
                  events:
                    type: array
                    items:
                      type: string
                  webhooks:
                    type: array
                    items:
                      $ref: '#/components/schemas/Webhook'
                required:
                - webhooks
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          $ref: '#/components/responses/ServerError'
    post:
      operationId: createWebhook
      summary: Add a webhook
      description: Owners only. The signing secret is shown only in this reply (and on rotate).
      tags:
      - Integrations
      parameters:
      - name: workspace
        in: query
        description: Which of your workspaces, by id or name. The current one when left out.
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                url:
                  type: string
                  description: https address
                  minLength: 1
                  maxLength: 500
                events:
                  type: array
                  items:
                    type: string
                    enum:
                    - watch.signal
                    - role.fits
                  minItems: 1
                  maxItems: 2
                  uniqueItems: true
                  description: Both when left out
                description:
                  type:
                  - string
                  - 'null'
                  maxLength: 100
              required:
              - url
              additionalProperties: false
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  webhook:
                    $ref: '#/components/schemas/Webhook'
                  secret:
                    type: string
                required:
                - webhook
                - secret
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          $ref: '#/components/responses/ServerError'
    servers:
    - url: https://ayhire.com
  /api/integrations/webhooks/{id}:
    patch:
      operationId: updateWebhook
      summary: Change a webhook
      description: 'Owners only. `active: true` on a paused webhook also clears the pause and the failure count.'
      tags:
      - Integrations
      parameters:
      - name: id
        in: path
        required: true
        description: The webhook's id (a UUID)
        schema:
          type: string
      - name: workspace
        in: query
        description: Which of your workspaces, by id or name. The current one when left out.
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                url:
                  type: string
                  minLength: 1
                  maxLength: 500
                events:
                  type: array
                  items:
                    type: string
                    enum:
                    - watch.signal
                    - role.fits
                  minItems: 1
                  maxItems: 2
                  uniqueItems: true
                description:
                  type:
                  - string
                  - 'null'
                  maxLength: 100
                active:
                  type: boolean
              minProperties: 1
              additionalProperties: false
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  webhook:
                    $ref: '#/components/schemas/Webhook'
                required:
                - webhook
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          $ref: '#/components/responses/ServerError'
    delete:
      operationId: deleteWebhook
      summary: Delete a webhook
      description: Owners only. Idempotent; deliveries waiting for it go too.
      tags:
      - Integrations
      parameters:
      - name: id
        in: path
        required: true
        description: The webhook's id (a UUID)
        schema:
          type: string
      - name: workspace
        in: query
        description: Which of your workspaces, by id or name. The current one when left out.
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  deleted:
                    type: boolean
                required:
                - deleted
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          $ref: '#/components/responses/ServerError'
    servers:
    - url: https://ayhire.com
  /api/integrations/webhooks/{id}/deliveries:
    get:
      operationId: listWebhookDeliveries
      summary: A webhook's last deliveries, newest first
      tags:
      - Integrations
      parameters:
      - name: id
        in: path
        required: true
        description: The webhook's id (a UUID)
        schema:
          type: string
      - name: workspace
        in: query
        description: Which of your workspaces, by id or name. The current one when left out.
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  deliveries:
                    type: array
                    items:
                      $ref: '#/components/schemas/WebhookDelivery'
                  max:
                    type: integer
                  days:
                    type: integer
                required:
                - deliveries
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          $ref: '#/components/responses/ServerError'
    servers:
    - url: https://ayhire.com
  /api/integrations/webhooks/{id}/deliveries/{delivery}/resend:
    post:
      operationId: resendWebhookDelivery
      summary: Send a delivery again
      description: Owners only. Same body and same X-AyHire-Delivery id. 200 whatever the receiver said; 400 when it can't be sent again. 10 a minute.
      tags:
      - Integrations
      parameters:
      - name: id
        in: path
        required: true
        description: The webhook's id (a UUID)
        schema:
          type: string
      - name: delivery
        in: path
        required: true
        description: The delivery's id (a UUID), the X-AyHire-Delivery header its receiver saw
        schema:
          type: string
      - name: workspace
        in: query
        description: Which of your workspaces, by id or name. The current one when left out.
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                allOf:
                - type: object
                  properties:
                    ok:
                      type: boolean
                      description: The receiver answered 2xx
                    status:
                      type:
                      - integer
                      - 'null'
                    ms:
                      type: integer
                    error:
                      type:
                      - string
                      - 'null'
                  required:
                  - ok
                - type: object
                  properties:
                    delivery:
                      $ref: '#/components/schemas/WebhookDelivery'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          $ref: '#/components/responses/ServerError'
    servers:
    - url: https://ayhire.com
  /api/integrations/webhooks/{id}/rotate:
    post:
      operationId: rotateWebhookSecret
      summary: A new signing secret
      description: Owners only. Shown only in this reply; requests signed with the old one stop matching at once.
      tags:
      - Integrations
      parameters:
      - name: id
        in: path
        required: true
        description: The webhook's id (a UUID)
        schema:
          type: string
      - name: workspace
        in: query
        description: Which of your workspaces, by id or name. The current one when left out.
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  webhook:
                    $ref: '#/components/schemas/Webhook'
                  secret:
                    type: string
                required:
                - webhook
                - secret
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          $ref: '#/components/responses/ServerError'
    servers:
    - url: https://ayhire.com
  /api/integrations/webhooks/{id}/test:
    post:
      operationId: testWebhook
      summary: Send a signed ping now
      description: Owners only. 200 whatever the receiver said; 10 tests a minute.
      tags:
      - Integrations
      parameters:
      - name: id
        in: path
        required: true
        description: The webhook's id (a UUID)
        schema:
          type: string
      - name: workspace
        in: query
        description: Which of your workspaces, by id or name. The current one when left out.
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  ok:
                    type: boolean
                    description: The receiver answered 2xx
                  status:
                    type:
                    - integer
                    - 'null'
                  ms:
                    type: integer
                  error:
                    type:
                    - string
                    - 'null'
                required:
                - ok
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          $ref: '#/components/responses/ServerError'
    servers:
    - url: https://ayhire.com
components:
  responses:
    NotFound:
      description: Nothing with that id, or not on your account (code not_found)
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Unauthorized:
      description: No API key, or a revoked one (code unauthorized)
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    BadRequest:
      description: The request is not valid (code validation_error)
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    RateLimited:
      description: An hourly or per-minute limit is spent; the message says when it resets (code rate_limited or github_rate_limited)
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Forbidden:
      description: Not allowed for this caller, e.g. a workspace member where an owner is needed (code forbidden)
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    ServerError:
      description: Something failed on AyHire's side (code internal_error)
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  schemas:
    WebhookDelivery:
      type: object
      properties:
        id:
          type: string
          description: The X-AyHire-Delivery header its receiver saw
          format: uuid
        event_type:
          type: string
        status:
          type: string
        attempts:
          type: integer
        last_status:
          type:
          - integer
          - 'null'
        last_error:
          type:
          - string
          - 'null'
        created_at:
          type: string
          format: date-time
        sent_at:
          type:
          - string
          - 'null'
        next_attempt_at:
          type:
          - string
          - 'null'
        github_username:
          type:
          - string
          - 'null'
        role_title:
          type:
          - string
          - 'null'
        can_resend:
          type: boolean
      required:
      - id
      - status
    Error:
      type: object
      properties:
        error:
          type: string
          description: What went wrong, in a sentence
        code:
          type: string
          description: Stable code to branch on
          enum:
          - unauthorized
          - forbidden
          - not_found
          - payment_required
          - rate_limited
          - github_rate_limited
          - validation_error
          - internal_error
        hint:
          type: string
          description: What to do about it, when there is something
      required:
      - error
      - code
    AtsConnection:
      type: object
      properties:
        provider:
          type: string
        name:
          type: string
        account:
          type:
          - string
          - 'null'
        auto_send:
          type: boolean
        default_job:
          oneOf:
          - type: object
            properties:
              id:
                type: string
                minLength: 1
                maxLength: 200
              title:
                type: string
                maxLength: 200
            required:
            - id
            - title
          - type: 'null'
        jobs:
          type: boolean
          description: The ATS has jobs to pick
        needs_job:
          type: boolean
        last_ok_at:
          type:
          - string
          - 'null'
        last_error:
          type:
          - string
          - 'null'
        created_at:
          type: string
          format: date-time
    Webhook:
      type: object
      properties:
        id:
          type: string
          format: uuid
        url:
          type: string
          description: The full address for owners; cut to its host for members
        host:
          type: string
        description:
          type:
          - string
          - 'null'
        events:
          type: array
          items:
            type: string
            enum:
            - watch.signal
            - role.fits
        active:
          type: boolean
        disabled_reason:
          type:
          - string
          - 'null'
        last_status:
          type:
          - integer
          - 'null'
        last_error:
          type:
          - string
          - 'null'
        last_attempt_at:
          type:
          - string
          - 'null'
        last_success_at:
          type:
          - string
          - 'null'
        created_at:
          type: string
          format: date-time
      required:
      - id
      - url
      - events
      - active
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: ayh_ API key
      description: 'An AyHire API key: Authorization: Bearer ayh_...'
    apiKeyHeader:
      type: apiKey
      in: header
      name: x-api-key
      description: The same AyHire API key, in x-api-key
externalDocs:
  description: AyHire for agents
  url: https://ayhire.com/agents.md
x-refined-from:
- ayhire-com-openapi.json
- ayhire-com-openapi.yml