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

GEThttps://api-uat.mioid.preventor.com/v1/business/settings/webhooks

Authorization

JWT-auth

Header parameters

Response

200401403500

List of your configured webhooks

Body

application/json

type*enum

Example: "REQUEST_RESULT"

REQUEST_RESULTWHT_002

url*string

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

secretstring

Example: "my-32-bytes-sized-secret"

authorizationWebhookAuthorizationDto (object)

headersobject

Request

JavaScriptCurlPython

const response = await fetch('https://api-uat.mioid.preventor.com/v1/business/settings/webhooks', {
    method: 'GET',
    headers: {
      "Authorization": "text",
      "x-api-key": "text"
    },
});
const data = await response.json();

Response

200401403500

[
  {
    "type": "REQUEST_RESULT",
    "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"
    }
  }
]

Creates a new or updates an existent webhook

Creates a new or updates an existent webhook for integration

PUThttps://api-uat.mioid.preventor.com/v1/business/settings/webhooks

Authorization

JWT-auth

Header parameters

Body

application/json

type*enum

Example: "REQUEST_RESULT"

REQUEST_RESULTWHT_002

url*string

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

secretstring

Example: "my-32-bytes-sized-secret"

authorizationWebhookAuthorizationDto (object)

headersobject

Response

204400401403500

Your webhook has been created or updated on your configurations successfully

Request

JavaScriptCurlPython

const response = await fetch('https://api-uat.mioid.preventor.com/v1/business/settings/webhooks', {
    method: 'PUT',
    headers: {
      "Authorization": "text",
      "x-api-key": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "type": "REQUEST_RESULT",
      "url": "https://www.mycompanyhost.com/my-webhook"
    }),
});
const data = await response.json();

Response

400401403500

{
  "status": 400,
  "code": "BDRQST",
  "message": "Some properties are invalid or missing on your request"
}

Deletes your configured webhook

Removes from your webhook list the item for the specified ID

DELETEhttps://api-uat.mioid.preventor.com/v1/business/settings/webhooks/{id}

Authorization

JWT-auth

Path parameters

id*string

Example: "my-webhook-id"

Header parameters

Response

204400401403404500

Your webhook has been removed from your configurations successfully

Request

JavaScriptCurlPython

const response = await fetch('https://api-uat.mioid.preventor.com/v1/business/settings/webhooks/{id}', {
    method: 'DELETE',
    headers: {
      "Authorization": "text",
      "x-api-key": "text"
    },
});
const data = await response.json();

Response

400401403404500

{
  "status": 400,
  "code": "BDRQST",
  "message": "Some properties are invalid or missing on your request"
}