The Webhook Endpoint object
A WebhookEndpoint represents a URL you register to receive Event notifications. It stores the event types it subscribes to and the signing secret Fintoc uses to verify delivery. You create a WebhookEndpoint when you set up webhooks, and Fintoc sends enabled events to its url in live or test mode.
{
"id": "we_M6yrvOepCe3Rqp8B",
"object": "webhook_endpoint",
"created_at": "2021-05-17T17:04:10.284Z",
"description": "Webhook endpoint for payment events.",
"enabled_events": ["link.created", "link.credentials_changed"],
"mode": "live",
"secret": "...",
"status": "enabled",
"url": "https://my.webhook.endpoint/fintoc"
}| Attribute | Type | Description |
|---|---|---|
id | string | Unique identifier for the Webhook Endpoint |
object | string | Identifier for the type of object. Its value for Webhook Endpoints will always correspond to webhook_endpoint |
created_at | string | Webhook Endpoint's creation date, using ISO 8601 |
description | string | Optional description about the Webhook Endpoint's purpose |
enabled_events | Array[string] | Events that will be sent to the Webhook Endpoint |
mode | string | Indicates whether the Webhook Endpoint is in live mode or in test mode (for the sandbox) |
secret | string | Token Fintoc uses to generate the webhook signatures. Use this token to validate that Fintoc sent the webhook. Fintoc returns this field only when you create the webhook endpoint. Later requests return null. |
status | string | Indicates whether the Webhook Endpoint is active (enabled) or inactive (disabled) |
url | string | The URL associated to the webhook to which the events will be sent |