Webhook endpoint object

The Webhook Endpoint object

A WebhookEndpoint represents a URL that you register to receive Event notifications. The object stores its subscribed event types and the secret you use to validate webhook signatures. When you configure webhooks, Fintoc sends subscribed events to the endpoint’s url in live or test mode.

Webhook Endpoint Object

{
  "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"
}

The WebhookEndpoint object has the following attributes:

Attribute	Type	Description
`id`	`string`	Unique identifier for the `WebhookEndpoint`.
`object`	`string`	Type of the object. Always `webhook_endpoint`.
`created_at`	`string`	ISO 8601 datetime in UTC when Fintoc created the `WebhookEndpoint`.
`description`	`string`	Optional description of the `WebhookEndpoint`’s purpose.
`enabled_events`	`Array[string]`	Event types that Fintoc sends to the `WebhookEndpoint`.
`mode`	`string`	Mode in which the `WebhookEndpoint` operates. One of `live` or `test`.
`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`	Current state of the `WebhookEndpoint`. One of `enabled` (active) or `disabled` (inactive).
`url`	`string`	URL to which Fintoc sends subscribed events.

Fintoc API

Main Resources

Payments API

Transfers API

Movements API

Direct Debit (Legacy)

Fiscal API

Webhook endpoint object

The Webhook Endpoint object

​The Webhook Endpoint object

The Webhook Endpoint object