> ## Documentation Index
> Fetch the complete documentation index at: https://docs.truv.com/llms.txt
> Use this file to discover all available pages before exploring further.

# The Webhook Endpoint object

> Learn how to create a webhook configuration to receive updates from Truv platform

Webhooks provide a way for Truv to communicate to your servers when specific events happen. For example, when an account link connects successfully or new pay statements were added, you can receive notifications in realtime.

To start receiving webhooks, your web application needs to expose a publicly accessible URL. Use that URL to create a webhook configuration.

After creating a webhook configuration, you will receive POST requests with the event payloads that contain information about the events that have been triggered.

# Attributes

| Attribute    | Type    | Description                                                   |
| :----------- | :------ | :------------------------------------------------------------ |
| id           | string  | Unique ID of webhook configuration                            |
| name         | string  | Public name for webhook configuration                         |
| webhook\_url | string  | Webhook URL to send event data                                |
| events       | string  | List of events connected to webhook URL                       |
| env\_type    | string  | Type of environment, `sandbox`, `dev`, or `prod`              |
| enabled      | boolean | Whether the webhook is active                                 |
| created\_at  | string  | ISO 8601 value for when the webhook configuration was created |
| updated\_at  | string  | ISO 8601 value for when the webhook configuration was updated |

<Note>
  Truv may automatically disable a production webhook endpoint that fails continuously. The owner is notified by email before and after the endpoint is disabled, and delivery stops until you re-enable it. Re-enable a disabled endpoint by sending `"enabled": true` to the [update endpoint](/api-reference/webhooks/webhooks_partial_update).
</Note>

# Endpoints

Available endpoints for Webhooks are in the list below.

* [List all webhook endpoints](/api-reference/webhooks/webhooks_list) - GET /webhooks/
* [Create a webhook endpoint](/api-reference/webhooks/webhooks_create) - POST /webhooks/
* [Retrieve a webhook endpoint](/api-reference/webhooks/webhooks_read) - GET webhooks/\{id}/
* [Update a webhook endpoint](/api-reference/webhooks/webhooks_partial_update) - PATCH webhooks/\{id}/
* [Delete a webhook endpoint](/api-reference/webhooks/webhooks_delete) - DELETE webhooks/\{id}/

# Example response

View the response for the Webhooks endpoints below.

```json theme={null}
{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "name": "string",
  "webhook_url": "http://example.com/",
  "events": [
    "task-status-updated",
    "order-status-updated"
  ],
  "env_type": "dev",
  "enabled": true,
  "created_at": "2022-05-04T11:30:00Z",
  "updated_at": "2022-05-04T12:00:00Z"
}
```

# Webhook request history

## Overview

Use the Webhook request history endpoint to review and debug webhook delivery attempts made by Truv to your configured webhook URLs.

This endpoint returns a paginated list of webhook delivery attempts, including metadata such as delivery status and timestamps. It can help you:

* Confirm that Truv attempted to send a webhook
* Investigate failed deliveries (non-2xx responses, timeouts, etc.)
* Correlate webhook attempts with your internal logs
* Audit recent webhook activity

**Note:** Only webhook requests from the last 30 days are available.

## Endpoints

* [List webhook request history](/api-reference/webhooks/webhook_requests_list) - GET /webhook-requests/

## Example response

View the response for the Webhook request history endpoint below.

```json theme={null}
{
  "next": null,
  "previous": null,
  "results": [
    {
      "webhook_id": "48427a36d43c4d5aa6324bc06c692456",
      "event_type": "task-status-updated",
      "event_created_at": "2024-01-15T10:30:00Z",
      "status_code": 200,
      "error_message": null,
      "webhook_payload": {
        "webhook_id": "a3f5b7c9d1e2f4a6b8c0d2e4f6a8b0c2",
        "event_type": "order-status-updated",
        "event_created_at": "2026-01-27T00:00:16.279921Z",
        "product": "assets",
        "link_id": null,
        "user_id": "b4c6d8e0f2a4b6c8d0e2f4a6b8c0d2e4",
        "order_id": "c5d7e9f1a3b5c7d9e1f3a5b7c9d1e3f5",
        "status": "expired"
      },
      "webhook_url": "https://example.com/webhooks/truv"
    }
  ]
}
```