Webhooks

Introduction

Get All Registrations

GET https://api-staging.upwardli.com/v2/webhooks/registrations

Example Response:

1{
2    "count": 2,
3    "next": null,
4    "previous": null,
5    "results": [
6        {
7            "id": "{webhook_registration_id}",
8            "partner_id": "{partner_id}",
9            "webhook_name": "consumer.created",
10            "endpoint": "{webhook_endpoint}",
11            "status": "active",
12            "failures": 0,
13            "last_failure": null
14        },
15        {
16            "id": "{webhook_registration_id}",
17            "partner_id": "{partner_id}",
18            "webhook_name": "consumer.updated",
19            "endpoint": "{webhook_endpoint}",
20            "status": "active",
21            "failures": 0,
22            "last_failure": null
23        }
24    ]
25}

Get event history for a webhook

GET: https://api-staging.upwardli.com/v2/webhooks/{id}/events

Query Parameters

ParameterTypeRequiredDescription
start_datestringNoFilter events on or after this date. Format: YYYY-MM-DD (e.g. 2024-03-01). When omitted, all events are returned.

Example Request (with date filter):

GET: https://api-staging.upwardli.com/v2/webhooks/{id}/events?start_date=2024-03-01

Example Response:

1{
2    "count": 2,
3    "next": "https://api-sandbox.upwardli.com/v2/webhooks/{webhookd_registration_id}/events/?page=2",
4    "previous": null,
5    "results": [
6        {
7            "id": "{webhook_instance_id}",
8            "partner_id": "{partner_id}",
9            "created_at": "2023-10-23T14:22:14.555202Z",
10            "event_name": "creditline.updated",
11            "resources": [
12                "https://api-sandbox.upwardli.com/v2/creditline/{creditline_id}"
13            ],
14            "last_attempted_at": "2023-10-23T14:22:14.555247Z"
15        },
16        {
17            "id": "{webhook_instance_id}",
18            "partner_id": "{partner_id}",
19            "created_at": "2023-10-23T16:34:28.971724Z",
20            "event_name": "creditline.updated",
21            "resources": [
22                "https://api-sandbox.upwardli.com/v2/creditline/{creditline_id}"
23            ],
24            "last_attempted_at": "2023-10-23T16:34:28.971755Z"
25        }
26    ]
27}