Managing your Webhooks

How do I manage my Webhooks?

In order to be able to manage Webhooks through our API, please contact our sales team to enable that functionality on your account.

Authentication

All webhook endpoints require a valid API key passed via the Authorization header. If you don't have a valid API key, please contact our sales team.

Rate Limits

Limits

Each API key can have a maximum of 10 webhooks.

Event Types

The following event types are currently available for webhooks:

You can also retrieve the list of available event types programmatically via GET /api/v2/webhooks/event-types.

Webhook Object

Webhook Actions

Create a Webhook

API Reference: https://docs.daloopa.com/reference/create_webhook

curl --request POST \
     --url https://app.daloopa.com/api/v2/webhooks \

Creates a new webhook for the authenticated user.

Request Body

Example Request

{
  "url": "https://example.com/webhook",
  "event_type": "clientview_updated",
  "is_test": false,
  "header_name": "Authorization",
  "prefix": "Bearer",
  "auth_secret": "my-secret-token"
}

Response 201 Created

Returns the created Webhook object.

Errors

List your Webhooks

API Reference: https://docs.daloopa.com/reference/list_webhooks

curl --request GET \
     --url https://app.daloopa.com/api/v2/webhooks \

Returns all webhooks owned by the authenticated user. Supports pagination and filtering.

Query Parameters

Response 200 OK

{
  "count": 2,
  "next": null,
  "previous": null,
  "results": [
    {
      "id": 1,
      "url": "https://example.com/webhook",
      "event_type": "clientview_updated",
      "active": true,
      "is_test": false,
      "header_name": "Authorization",
      "prefix": "Bearer",
      "masked_auth_secret": "****oken",
      "created_at": "2025-01-15T10:30:00Z"
    }
  ]
}

Retrieve a Webhook

API Reference: https://docs.daloopa.com/reference/retrieve_webhook

curl --request GET \
     --url https://app.daloopa.com/api/v2/webhooks/{id} \

Returns a single webhook by its ID.

Path Parameters

Response 200 OK

Returns the Webhook object.

Errors

Update a Webhook

API Reference: https://docs.daloopa.com/reference/update_webhook

curl --request PATCH \
     --url https://app.daloopa.com/api/v2/webhooks/{id} \

Updates an existing webhook. Only the fields you include in the request body will be modified. At least one field must be provided.

Path Parameters

Request Body

All fields are optional, but at least one must be provided.

Example Request

{
  "url": "https://example.com/new-webhook-endpoint",
  "active": false
}

Response 200 OK

Returns the updated Webhook object.

Errors

Delete a Webhook

API Reference: https://docs.daloopa.com/reference/delete_webhook

curl --request DELETE \
     --url https://app.daloopa.com/api/v2/webhooks/{id} \

Permanently deletes a webhook. This action cannot be undone.

Path Parameters

Response 204 No Content

No response body.

Errors

List Event Types

API Reference: https://docs.daloopa.com/reference/list_webhook_types

curl --request GET \
     --url https://app.daloopa.com/api/v2/webhooks/event-types \

Returns the list of supported webhook event types.

Response 200 OK

[
  { "value": "clientview_updated", "label": "Clientview Updated" },
  { "value": "incremental_update", "label": "Incremental Update" },
  { "value": "series_updated", "label": "Series Updated" }
]

List Webhook Deliveries

curl --request GET \
     --url https://app.daloopa.com/api/v2/webhooks/deliveries \

Returns delivery history of webhooks registered under the authenticated user in reverse chronological order. Supports pagination and filtering.

Query Parameters

Response 200 OK

{
  "count": 1,
  "next": null,
  "previous": null,
  "results": [
    {
      "id": 1,
      "timestamp": "2025-01-15T10:30:00Z",
      "event_type": "clientview_updated",
      "company_id": 12345,
      "response_status": 200,
      "response_body": "OK",
      "is_test": false,
      "duration_ms": 142
    }
  ]
}

Delivery Object

FAQ

Is the auth_secret stored securely?

Yes. The auth_secret is stored encrypted. After creation, only the last 4 characters are visible via the masked_auth_secret field (e.g. ****oken).

What happens when I hit the webhook limit?

The POST /api/v2/webhooks endpoint returns 403 Forbidden with a message indicating the limit of 10 webhooks has been reached.

Can I deactivate a webhook without deleting it?

Yes. Send PATCH /api/v2/webhooks/{id} with {"active": false}. The webhook will stop receiving deliveries but can be reactivated later by setting active back to true.

What does a null response status on a delivery mean?

It means the request failed before receiving a response — typically a timeout or a connection error. Check the response_body field for the specific error message.