Sign in
latestSwagger 2.02026-08-20196638916.1 KB

23d8982b533d

Events v2.Webhook
REGION.US

Create Webhook Endpoint

The Events v2 Create Webhook Endpoint creates a subscription for a set of events to be delivered to a given endpoint URL. These webhooks are set to trigger whenever a subscribed event occurs for any user created for your app.

Please visit the relevant Tink product page in our documentation to learn more details on how to integrate and subscribe to webhook events related to product(s) you use.

Due to the unreliable nature of the principle on which Webhook operate, we do not provide several guarantees regarding the delivery of events. The guarantees we do not provide are:

  • Exactly-once delivery - Your webhook might be delivered multiple times or not be delivered at all.
  • In-order delivery - We do not guarantee the order of webhooks delivered; it is possible that newer webhooks are delivered before older ones.

Because of the lack of these guarantees, we are unable to establish Service Level Objectives.

We can only assure our best effort to send webhooks at least once. To ensure proper webhook delivery, we use a retry mechanism.

Events v2 Webhook are designed to handle temporary disruptions in webhook events delivery. In the event of receiving HTTP status codes 408, 429, 500, 502, 503, or 504 from your webhook endpoint, Tink will attempt to resend the webhook up to 3 times at exponential intervals. Tink won't retry delivery when establishing a connection to your client server is not possible. Our retry policy is subject to change at any time as part of our ongoing effort to improve webhook delivery reliability. We recommend checking this documentation for updates.

When registering a new Webhook, please be aware that there might be a delay of up to 15 minutes before receiving any events.

post/events/v2/webhook-endpoints

Request body

descriptionstring

An optional description of what the webhook is used for.

disabledboolean

Marks whether the webhook is disabled. Defaults to false.

enabledEventsstring[] required

The list of events to enable for this endpoint.

urlstring required

The URL of the webhook endpoint. Allowed schemes: https.

Example request

{
  "description": "Alice's webhook",
  "enabledEvents": [
    "refresh:finished"
  ],
  "url": "https://endpoint.example.com/"
}

Response

A successful response.