Keyo Webhooks

generated: '2026-07-19'
method: generated
source: https://developers.keyo.co/webhooks/overview
spec_type: AsyncAPI
asyncapi: 3.0.0
info:
  title: Keyo Webhooks
  version: 1.0.0
  description: >-
    Keyo delivers real-time notifications about palm biometric events within an
    organization by sending HTTP POST requests to a webhook endpoint URL
    registered in the organization dashboard. Generated by API Evangelist from
    Keyo's documented webhook event catalog (developers.keyo.co/webhooks). An
    optional shared-secret token is sent in the `X-Keyo-Token` header for
    receiver verification.
defaultContentType: application/json
servers:
  receiver:
    host: your-application.example.com
    protocol: https
    description: >-
      The publicly accessible HTTPS endpoint your application registers in the
      Keyo dashboard. Keyo POSTs events here.
channels:
  palmEvents:
    address: /your-webhook-endpoint
    description: The registered webhook endpoint that receives all Keyo palm events.
    messages:
      palmEnrollmentSucceeded:
        $ref: '#/components/messages/palmEnrollmentSucceeded'
      palmEnrollmentFailed:
        $ref: '#/components/messages/palmEnrollmentFailed'
      palmIdentificationSucceeded:
        $ref: '#/components/messages/palmIdentificationSucceeded'
      palmIdentificationFailed:
        $ref: '#/components/messages/palmIdentificationFailed'
operations:
  receivePalmEvents:
    action: receive
    channel:
      $ref: '#/channels/palmEvents'
    messages:
    - $ref: '#/channels/palmEvents/messages/palmEnrollmentSucceeded'
    - $ref: '#/channels/palmEvents/messages/palmEnrollmentFailed'
    - $ref: '#/channels/palmEvents/messages/palmIdentificationSucceeded'
    - $ref: '#/channels/palmEvents/messages/palmIdentificationFailed'
components:
  messages:
    palmEnrollmentSucceeded:
      name: palm.enrollment.succeeded
      title: Palm enrollment succeeded
      summary: A user's biometric data is enrolled.
      contentType: application/json
      payload:
        $ref: '#/components/schemas/Event'
    palmEnrollmentFailed:
      name: palm.enrollment.failed
      title: Palm enrollment failed
      summary: Encounters an error during enrollment.
      contentType: application/json
      payload:
        $ref: '#/components/schemas/Event'
    palmIdentificationSucceeded:
      name: palm.identification.succeeded
      title: Palm identification succeeded
      summary: User identified successfully.
      contentType: application/json
      payload:
        $ref: '#/components/schemas/Event'
    palmIdentificationFailed:
      name: palm.identification.failed
      title: Palm identification failed
      summary: Not able to identify user for some reason.
      contentType: application/json
      payload:
        $ref: '#/components/schemas/Event'
  schemas:
    Event:
      type: object
      properties:
        type:
          type: string
          description: The event type.
          enum:
          - palm.enrollment.succeeded
          - palm.enrollment.failed
          - palm.identification.succeeded
          - palm.identification.failed