Propelus webhooks notify you instantly when events occur, eliminating the need to poll for updates. Setup involves creating an endpoint, registering the webhook, receiving an activation code, and activating it. Webhooks can be managed via API to: list, update, or delete them. Statuses include active, pending, failed, and deleted. Failed deliveries are retried 5 times (hourly) and stored for 4 days if undelivered.
How setup works
- Create an endpoint. Your team stands up a URL that can receive Propelus’ messages.
- Register the webhook. Tell Propelus that URL and which event you want; you’ll get back a webhook ID.
- Receive an activation code. Propelus sends a short code to your URL to confirm it’s reachable and really yours.
- Activate. Confirm with the webhook ID and that code — and you’re live. Repeat for each event type.
Register the Webhook
- Login to obtain a temporary token (see Authentication Request).
- Register the Webhook.
Webhook Registration Definition
POST /v1/webhooks HTTP/1.1
Host: https://integrations.propelus.com
Content-Type: application/json
{
"eventType":"${event name}",
"url":"${client API endpoint URL}",
}
The following event types are available when registering a webhook:
| Event Type | Description |
|---|---|
| licenseVerification | Instant LCR Verification completed |
| monitoredLicenseVerified | Monitored LCR Verification completed |
| monitoredLicenseVerifiedChanged | Monitored LCR Verification complete AND results different from prior results |
| monitoredExclusionsCoreMatch | Monitored Exclusions Search completed AND exclusions found |
| monitoredExclusionsCoreMatchChanged | Monitored Exclusions Search completed AND results different from prior results |
Sample cURL request registering “licenseVerification” event at URL “https://enkmxrc66f85.x.pipedream.net/”
curl --location 'https://integrations.propelus.com/v1/webhooks' \
--header 'Content-Type: application/json' \
--header 'Authorization: ••••••' \
--data '{
"eventType": "licenseVerified",
"url": "https://enkmxrc66f85.x.pipedream.net/"
}'Sample Response
{
"status": 201,
"code": "activation_requested",
"id": "4595a894-5869-41bb-a206-0681c396b4b2",
"message": "Activation code sent."
}
Response Details
| Property | Value | Description |
|---|---|---|
| status | 200 | Status number |
| code | activation_requested | Status code text |
| id | 4595a894-5869-41bb-a206-0681c396b4b2 | A Propelus generated unique identifier for this webhook |
| message | Activation code sent. | Response message |
Activate the Webhook
Once the step above is completed a message is sent to the registered client webhook URL.
Sample Activation Code Message
{
"event": "activation",
"code": "BFE53E"
}
Sample Activation Code Message Details
| Property | Value | Description |
|---|---|---|
| event | activation | Type of event |
| code | BFE53E | Activation code needed to activate (enable) the webhook |
Use the “code” from the Activation Code Message and the “id” from the Registration Response to activate the webhook.
Sample Webhook Activation Request
curl --location --request POST 'https://integrations.propelus.com/v1/webhooks/4595a894-5869-41bb-a206-0681c396b4b2/activate/BFE53E' \
--header 'Authorization: ••••••'If the webhook is successfully activated the response will be similar to the sample below.
Sample Webhook Activation Response
{
"status": 200,
"code": "activated",
"message": "The webhook 4595a894-5869-41bb-a206-0681c396b4b2 has been enabled successfully."
}At this stage, the webhook is activated, and no further action is required. In this example, we utilized “licenseVerified,” so, whenever an instance LCR Verification request is sent, the results will be posted to the aforementioned webhook URL as soon as they become available.
The same steps can be repeated for each Event Type.
Where to go next