Webhooks configuration

Client Webhook Endpoints

Post a new webhook

Important: You can have all the webhooks that you need, even if it is the same action.

POST https://app.insurehero.io/api/shield/v1/webhooks

Headers

Name	Type	Description
Authorization*	string	Bearer access token

Request Body

Name	Type	Description
url*	string	The url where you want to receive an alert
action*	ActionType	The kind of action neccesary to run the webhook

ActionType

Name	Description
post-user	This action acts when a user is created
patch-user	This action acts when an user registry is updated, useful when an user is validated when otp
send-otp	Track everytime an user request an otp
post-group	This action acts when a group is created
update-group	This action acts when a group is updated
post-risk-item	This action acts when a risk item is created
update-risk-item	This action acts when a risk item is updated
post-risk-item-event	This action acts when an event is created
order-created	This action acts when an event is created
subscription-created	This action acts when a subscription is created
post-claim	This action acts when a claim is created
update-claim	This action acts when a claim is updated

Types of responses

200: OK Retrieved successfully

{
    "data": {
        "id": "87ff8ad7-ccd8-4634-b4cc-e20ae1492e8e",
        "created_at": "2024-08-12T15:00:09.332662+00:00",
        "channel_id": "fc94d4a1-f834-481d-a6b2-138b823389c8",
        "url": "https://eolt6awifrdystu.m.pipedream.net",
        "table": "risk_items",
        "action": "POST"
    }
}

400: Bad Request Request contains malformed data

{}

401: Unauthorized Invalid or expired access token

Delete a webhook

DELETE https://app.insurehero.io/api/shield/v1/webhooks/:webhookId

Headers

Name	Type	Description
Authorization*	string	Bearer access token

Path Parameters

Name	Type	Description
webhookId*	string	Webhook unique identifier

Types of responses

200: OK Retrieved successfully

{
    "data": "Webhook deleted sucesfully"
}

Get the data of all the webhooks

GET https://app.insurehero.io/api/shield/v1/webhooks

Headers

Name	Type	Description
Authorization*	string	Bearer access token

Query Params

Name	Type	Description
from*	number	Starting record index
to*	number	Ending record index

Types of responses

200: OK Retrieved successfully

{
    "data": [
        {
            "id": "eb460600-9162-414e-b657-bd2e48e200d5",
            "created_at": "2024-08-08T21:02:24.588648+00:00",
            "channel_id": "fc94d4a1-f834-481d-a6b2-138b823389c8",
            "url": "wwww.example.com",
            "table": "claims",
            "action": "POST"
        },
        {
            "id": "95a106bd-2aaf-4c30-add4-90b16cf8a8ad",
            "created_at": "2024-08-12T14:32:50.880461+00:00",
            "channel_id": "fc94d4a1-f834-481d-a6b2-138b823389c8",
            "url": "wwww.example.com",
            "table": "risk_items",
            "action": "POST"
        }
    ]
}

Get the data of a webhooks

GET https://app.insurehero.io/api/shield/v1/webhooks/:webhookId

Headers

Name	Type	Description
Authorization*	string	Bearer access token

Path Parameters

Name	Type	Description
webhookId*	string	Webhook unique identifier

Types of responses

200: OK Retrieved successfully

{
    "data": {
        "id": "eb460600-9162-414e-b657-bd2e48e200d5",
        "created_at": "2024-08-08T21:02:24.588648+00:00",
        "channel_id": "fc94d4a1-f834-481d-a6b2-138b823389c8",
        "url": "wwww.example.com",
        "table": "claims",
        "action": "POST"
    }
}