Webhooks
Registration

Register your hooks

Register a hook

Request:

HTTP POST /api/v1/subscribe Body:

{
    "name": "my-hook",
    "url": "",
    "method": "POST",
    "headers": {},
    "company_profile_id": "",
    "events": [],
}

Response:

{
    "subscription": {"id": null},
    "message": "",
    "actions": []
}

List hooks

Request:

HTTP GET /api/v1/list?profile_id=UUID

Response:

[{
    "subscription": {"id": null},
    "message": "",
    "actions": []
}]

Unregister a hook

Request:

HTTP DELETE /api/v1/unsubscribe Parameters:

  • id (required)

Response:

{
"id": "UUID"
}