Webhooks - Update, Delete and List Active

In this article, the following topics are covered:

• List Webhooks
• Update a Webhook
• Delete a Webhook
• Webhook Callback Authentication
• Instructions for creating a webhook: Webhooks - Creation, Registration & Activation

1. Login to obtain a temporary token (see Authentication Request)
2. List the Webhooks:

Sample List Webhooks Request

curl --location 'https://integrations.propelus.com/v1/webhooks' \
--header 'Authorization: ••••••'

Sample List Webhooks Response

{    "items": [
        {            
            "addedAt": "2024-05-23T15:40:18.554Z",
            "updatedAt": "2024-05-23T15:41:04.535Z",
            "status": "ACTIVE",
            "eventType": "monitoredExclusionsCoreChanged",
            "url": "https://eo6fpbzi8ihjb9e.m.pipedream.net",
            "id": "897dfa01-a502-4088-86aa-742f0110230c",
            "clientId": "v1234567vmuhhWKXXXXXXXXaAQ4S"
        },
        {
            "addedAt": "2024-06-18T19:05:40.234Z",
            "updatedAt": "2024-06-18T19:16:32.406Z",            
            "status": "ACTIVE",
            "eventType": "licenseVerified",
            "url": "https://enkmxrc66f85.x.pipedream.net/",
            "id": "4595a894-5869-41bb-a206-0681c396b4b2",
            "clientId": "v1234567vmuhhWKXXXXXXXXaAQ4S"
        }
    ],
    "size": 2
}

List Webhooks Response Details

Webhook Status Values:
•	active — Webhook is operational and receiving events
•	pending — Webhook created but not yet verified/activated
•	deleted — Webhook has been deleted
•	failed — Webhook verification process failed

To update the callback URL or the eventType for a webhook, follow the steps below:

1. Login to obtain a temporary token (see Authentication Request)
2. If needed, list the webhooks to obtain the "id" for the webhook.

3. Call the update webhook endpoint, supplying the webhook id in the URL string and the new event type as a body property.

Sample Update Webhook Event Type

curl --location --request PATCH 'https://integrations.propelus.com/v1/webhooks/4595a894-5869-41bb-a206-0681c396b4b2' \
--header 'Content-Type: application/json' \--header 'Authorization: ••••••' \--data '{    "eventType": "monitoredExclusionsCoreMatch",}'

Sample Update Webhook Event Type Response

{
    "status": 200,
    "code": "updated",
    "id": "4595a894-5869-41bb-a206-0681c396b4b2",
    "message": "The webhook 4595a894-5869-41bb-a206-0681c396b4b2 has been updated successfully."
}

4. Call the update webhook endpoint, supplying the webhook id in the URL string and the new URL as a body property.

Sample Update Webhook Event Type

curl --location --request PATCH 'https://integrations.propelus.com/v1/webhooks/4595a894-5869-41bb-a206-0681c396b4b2' \
--header 'Content-Type: application/json' \
--header 'Authorization: ••••••' \
--data '{    "url": "https://en7rtgxye3mri.x.pipedream.net/"
}'

Sample Update Webhook Event Type Response

{
    "status": 200,
    "code": "activation_requested",
    "id": "4595a894-5869-41bb-a206-0681c396b4b2",
    "message": "The webhook 4595a894-5869-41bb-a206-0681c396b4b2 has been updated successfully and the code has been sent."
}

(!) Important Note: When a webhook URL changed, re-activation required. See (v.b) Webhooks - Creation, Registration & Activation for [re]activation steps.

1. Login to obtain a temporary token (see Authentication)
2. If needed, list the webhooks to obtain the "id" for the webhook.
3. Call the delete webhook endpoint, supplying the webhook id in the URL string:

Sample Delete Webhook Request

curl --location --request DELETE 'https://integrations.propelus.com/v1/webhooks/41060db3-1a95-4d8b-a16e-b727d236d1c5' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VybmFtZSI6Imt5bGVncmF5KzEyMjRAZ21haWwuY29tIiwic3ViIjoia3lsZWdyYXkrMTIyNEBnbWFpbC5jb20iLCJpYXQiOjE3MTg3MzY1NTJ9.SIJZEz8ze17brrifaZtuT3Wtd6sPJjeOuQPPs3doXJA'

Sample Delete Webhook Response

{
    "status": 200,
    "code": "deleted",
    "message": "The webhook 41060db3-1a95-4d8b-a16e-b727d236d1c5 has been deleted successfully."
}

Note: A webhook remains in the list of webhooks, with the status of "deleted".

This feature provides a way for a client to further secure their callback URL, by requiring an authentication method for the webhook callback requests.

The authentication method can be included when creating and/or updating the webhook.

To configure authentication for the webhook callback request, see this article: (v.b) Authentication

Where to go next

Webhook Security Measures