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 your configured webhooks list

Retrieves your configured webhooks list

GEThttps://api.preventor.com/mio-id/apps/settings/webhooks

Authorization

JWT-auth

Header parameters

Response

200401403500

List of your configured webhooks

Body

application/json

type*enum

REQUEST_RESULT

url*string

secretstring

authorizationWebhookAuthorizationDto (object)

headersobject

Request

JavaScriptCurl

const response = await fetch('https://api.preventor.com/mio-id/apps/settings/webhooks', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();

Response

[
  {
    "type": "REQUEST_RESULT",
    "url": "https://www.mycompanyhost.com/my-webhook",
    "secret": "my-32-bytes-sized-secret",
    "authorization": {
      "type": "BASIC_AUTH"
    },
    "headers": {
      "Content-Type": "application/json"
    }
  }
]

Creates a new or updates an existant webhook

Creates a new or updates an existant webhook for integration

PUThttps://api.preventor.com/mio-id/apps/settings/webhooks

Authorization

JWT-auth

Header parameters

Body

application/json

type*enum

REQUEST_RESULT

url*string

secretstring

authorizationWebhookAuthorizationDto (object)

headersobject

Response

204400401403500

Your webhook has been created or updated on your configurations successfully

Request

JavaScriptCurl

const response = await fetch('https://api.preventor.com/mio-id/apps/settings/webhooks', {
    method: 'PUT',
    headers: {
      "Authorization": "Bearer JWT",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "type": "REQUEST_RESULT",
      "url": "https://www.mycompanyhost.com/my-webhook"
    }),
});
const data = await response.json();

Deletes your configured webhook

Removes from your webook list the item for the specified ID

DELETEhttps://api.preventor.com/mio-id/apps/settings/webhooks/{id}

Authorization

JWT-auth

Path parameters

id*string

Header parameters

Response

204400401403404500

Your webhook has been removed from your configurations successfully

Request

JavaScriptCurl

const response = await fetch('https://api.preventor.com/mio-id/apps/settings/webhooks/{id}', {
    method: 'DELETE',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();