Registration

Registering your Webhook Service

To properly set up and receive incoming webhooks, your server must expose an endpoint capable of handling the following:

Webhooks are delivered as POST requests. The payload format depends on the configuration.

Encrypted Payload: If a secret key is set, the payload will be delivered in raw text/plain. Unencrypted Payload: If no secret key is configured, the payload will be in standard application/json format.

Testing Webhooks

Before deploying, you can test your webhook configuration using tools like https://webhook.site/. These services allow you to capture and inspect the incoming requests to ensure your server is correctly processing them.

Steps to Register you Webhook

Configure your endpoint: - Listen for POST requests. - Handle both text/plain and application/json payloads. - Verify and authenticate requests if using a secret.

Test your endpoint:

Use your developer dashboard to send test events or utilize external tools to verify the behavior of your webhook service.

User our Webhoos API:

To officially register your webhook service with the platform:

Refer to the Webhooks API documentation for detailed guidance on setting up and managing your webhook configurations.

Provide the required details such as endpoint URL, subscribed events, and optional secret key for validation.

By following these steps, you can ensure a seamless integration and reliable handling of event notifications from the mio.ID platform.