Webhooks configuration

In order to receive your users' request approvals/denials results, you must configure a webhook first. Please, take a look at following requests and our webhooks section.

Retrieves webhooks list

Retrieves your configured webhooks list

get

/v1/business/settings/webhooks

Authorizations

Header parameters

Authorizationstringrequired

Your JWT token as Bearer

x-api-keystringrequired

Your credential's unique identifier key

x-pvt-timezonestring

Your timezone

Responses

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api-uat.mioid.preventor.com/v1/business/settings/webhooks' \
  --header 'Authorization: text' \
  --header 'x-api-key: text'

200

401

403

500

200

[
  {
    "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"
      }
    },
    "type": "REQUEST_RESULT",
    "headers": {
      "Content-Type": "application/json"
    }
  }
]

List of your configured webhooks

Creates a new or updates an existent webhook

Creates a new or updates an existent webhook for integration

put

/v1/business/settings/webhooks

Authorizations

Header parameters

Authorizationstringrequired

Your JWT token as Bearer

x-api-keystringrequired

Your credential's unique identifier key

x-pvt-timezonestring

Your timezone

Body

urlstringrequired

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

secretstring

Example: my-32-bytes-sized-secret

authorizationobject

typestring · enumrequired

Example: REQUEST_RESULT

Options: REQUEST_RESULT, WHT_002

headersobject

Example: {"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-uat.mioid.preventor.com/v1/business/settings/webhooks' \
  --header 'Authorization: text' \
  --header 'x-api-key: text' \
  --header 'Content-Type: application/json' \
  --data '{
    "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"
      }
    },
    "type": "REQUEST_RESULT",
    "headers": {
      "Content-Type": "application/json"
    }
  }'

204

400

401

403

500

204

No body

Your webhook has been created or updated on your configurations successfully

Deletes your configured webhook

Removes from your webhook list the item for the specified ID

delete

/v1/business/settings/webhooks/{id}

Authorizations

Path parameters

idstringrequired

Example: my-webhook-id

Header parameters

Authorizationstringrequired

Your JWT token as Bearer

x-api-keystringrequired

Your credential's unique identifier key

x-pvt-timezonestring

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-uat.mioid.preventor.com/v1/business/settings/webhooks/{id}' \
  --header 'Authorization: text' \
  --header 'x-api-key: text'

204

400

401

403

404

500

204

No body

Your webhook has been removed from your configurations successfully