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. API endpoints

Webhooks

Last updated 6 months ago

The Webhooks feature allows you to configure endpoints on your server to receive real-time event notifications from our system. By setting up a webhook, you can automate workflows, track updates, or respond to specific events programmatically.

GET

PUT

DELETE

List of webhooks
Create/Update webhook
Delete your webhook

Retrieves webhooks list

get

Retrieves your configured webhooks list

Authorizations
Header parameters
x-api-keystringRequired

Your credential's unique identifier key

x-pvt-timezonestringOptional

Your timezone

Responses
200
List of your configured webhooks
application/json
401
Unauthorized access due to invalid credentials, invalid or expired JWT token
application/json
403
Your key, your credentials or your JWT token are invalid, or you don't have access for this resource
application/json
500
An unexpected error has been raised durig this process
application/json
get
GET /business/v1/settings/webhooks HTTP/1.1
Host: api.mio.id
Authorization: Bearer JWT
x-api-key: text
Accept: */*

[
  {
    "type": "ACTIVITY_EVENT",
    "url": "https://www.mycompanyhost.com/my-webhook",
    "secret": "my-32-bytes-sized-secret",
    "authorization": {
      "type": "BASIC_AUTH",
      "value": {
        "username": "my-user-name",
        "password": "my-secure-password"
      }
    },
    "headers": {
      "Content-Type": "application/json"
    }
  }
]

Deletes your configured webhook

delete

Removes from your webhook list the item for the specified ID

Authorizations
Path parameters
idstringRequiredExample: my-webhook-id
Header parameters
x-api-keystringRequired

Your credential's unique identifier key

x-pvt-timezonestringOptional

Your timezone

Responses
204
Your webhook has been removed from your configurations successfully
400
Your request metadata or your payload contains incorrect values
application/json
401
Unauthorized access due to invalid credentials, invalid or expired JWT token
application/json
403
Your key, your credentials or your JWT token are invalid, or you don't have access for this resource
application/json
404
No resource found for specified identifier
application/json
500
An unexpected error has been raised durig this process
application/json
delete
DELETE /business/v1/settings/webhooks/{id} HTTP/1.1
Host: api.mio.id
Authorization: Bearer JWT
x-api-key: text
Accept: */*

No content
  • GETRetrieves webhooks list
  • PUTCreates a new or updates an existent webhook
  • DELETEDeletes your configured webhook

Creates a new or updates an existent webhook

put

Creates a new or updates an existent webhook for integration

Authorizations
Header parameters
x-api-keystringRequired

Your credential's unique identifier key

x-pvt-timezonestringOptional

Your timezone

Body
typestring ยท enumRequiredExample: ACTIVITY_EVENTPossible values:
urlstringRequiredExample: https://www.mycompanyhost.com/my-webhook
secretstringOptionalExample: my-32-bytes-sized-secret
headersobjectOptionalExample: {"Content-Type":"application/json"}
Responses
204
Your webhook has been created or updated on your configurations successfully
400
Your request metadata or your payload contains incorrect values
application/json
401
Unauthorized access due to invalid credentials, invalid or expired JWT token
application/json
403
Your key, your credentials or your JWT token are invalid, or you don't have access for this resource
application/json
500
An unexpected error has been raised durig this process
application/json
put
PUT /business/v1/settings/webhooks HTTP/1.1
Host: api.mio.id
Authorization: Bearer JWT
x-api-key: text
Content-Type: application/json
Accept: */*
Content-Length: 262

{
  "type": "ACTIVITY_EVENT",
  "url": "https://www.mycompanyhost.com/my-webhook",
  "secret": "my-32-bytes-sized-secret",
  "authorization": {
    "type": "BASIC_AUTH",
    "value": {
      "username": "my-user-name",
      "password": "my-secure-password"
    }
  },
  "headers": {
    "Content-Type": "application/json"
  }
}
No content