mio.ID Business
  • Getting started
    • Overview
  • API Reference
    • Data Dictionary
      • Glossary
        • Entity or Member
        • Activity
        • Requirement
      • Objects
        • Entity or Member
        • Activity
        • Requirement
        • Webhook
    • API endpoints
  • webhooks
    • Registration
    • Security
Powered by GitBook
On this page
  1. API Reference
  2. Data Dictionary
  3. Objects

Webhook

The Webhook object facilitates the integration of your application with the mio.ID platform by enabling real-time event notifications. This object defines a configured endpoint in your system that receives notifications about actions or changes in mio.ID services, ensuring seamless automation and synchronization.

Field
Type
Description

type

string

Specifies the type of webhook.

url

string

The URL of your service to be used as the webhook endpoint.

secret

string

A secret key used to cipher messages for secure communication. Note: Refer to Webhooks Configuration for details about the ciphering process.

authorization

object

Provides options for securing your service using one of the following methods:

  • Basic authentication

  • Bearer token authorization

  • API key

headers

object

Allows configuration of additional metadata to be included in the headers for your service. This ensures compatibility with services requiring custom metadata.

This structure supports robust, secure integration for handling real-time updates and actions on the mio.ID platform.

PreviousRequirementNextRegistration

Last updated 5 months ago