Webhooks

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 List of webhooks

PUT Create/Update webhook

DELETE 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

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.mio.id/business/v1/settings/webhooks' \
  --header 'Authorization: Bearer JWT' \
  --header 'x-api-key: text'

200

401

403

500

200

[
  {
    "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"
    }
  }
]

List of your configured webhooks

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_EVENTAvailable options:

urlstringrequiredExample: https://www.mycompanyhost.com/my-webhook

secretstringoptionalExample: my-32-bytes-sized-secret

authorizationobjectoptional

headersobjectoptionalExample: {"Content-Type":"application/json"}

Responses

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url 'https://api.mio.id/business/v1/settings/webhooks' \
  --header 'Authorization: Bearer JWT' \
  --header 'x-api-key: text' \
  --header 'Content-Type: application/json' \
  --data '{
    "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"
    }
  }'

204

400

401

403

500

204

No Content

Your webhook has been created or updated on your configurations successfully

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

application/json

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url 'https://api.mio.id/business/v1/settings/webhooks/{id}' \
  --header 'Authorization: Bearer JWT' \
  --header 'x-api-key: text'

204

400

401

403

404

500

204

No Content

Your webhook has been removed from your configurations successfully