Webhooks

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, such as when an account link was successfully connected, new pay statements were added, etc.

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.

Webhook Attributes

AttributeTypeDescription
idstringUnique ID of the webhook config.
namestringPublic name for this webhook config.
webhook_urlstringWebhook URL where event data will be sent.
eventsstringList of events sent to this Webhook URL.
env_typeboolType of environment: production, development or sandbox.
created_atstringTimestamp when the webhook config was created (ISO 8601).
updated_atstringTimestamp when the webhook config was updated (ISO 8601).

Endpoints

Available endpoint list for Webhooks:

Endpoint
List all webhooks - GET /webhooks/
Create a webhook - POST /webhooks/
Retrieve a webhook - GET webhooks/{id}/
Update a webhook - PATCH webhooks/{id}/
Delete a webhook - DELETE webhooks/{id}/

Sample Object

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