New webhook event type: connection.failed

We have expanded our support for connection-related notifications. Use the connection.failed webhook to be alerted if your SMB customer encounters issues when connecting their business software.

What's new?

You can now subscribe to the connection.failed webhook. It provides details of the failed connection, including information on the specific error that occurred. This helps you quickly identify and address the issue.

Connection event type schema structure

{
  "id": "ba29118f-5406-4e59-b05c-ba307ca38d01",
  "eventType": "connection.failed",
  "generatedDate": "2024-08-08T17:10:34.015Z",
  "payload": {
    "referenceCompany": {
      "id": "0498e921-9b53-4396-a412-4f2f5983b0a2",
      "name": "Toft stores",
      "links": {
        "portal": "https://app.codat.io/companies/0498e921-9b53-4396-a412-4f2f5983b0a2/summary"
      },
      "tags": {
        "region": "us",
        "uid": "335a086e-8563-4b03-94e3-39544225ecb6"
      }
    },
    "connection": {
      "id": "ee2eb431-c0fa-4dc9-93fa-d29781c12bcd",
      "integrationId": "bf083d72-62c7-493e-aec9-81b4dbba7e2c",
      "integrationKey": "dfxm",
      "sourceId": "bdd831ce-eebd-4896-89a7-20e5ee8989ee",
      "platformName": "Basiq",
      "linkUrl": "https://link-api.codat.io/companies/0498e921-9b53-4396-a412-4f2f5983b0a2/connections/ee2eb431-c0fa-4dc9-93fa-d29781c12bcd/start",
      "status": "PendingAuth",
      "created": "2022-10-27T09:53:29.000Z",
      "sourceType": "Banking",
      "dataConnectionErrors": [
        {
          "statusCode": "403",
          "statusText": "User cancelled linking",
          "errorMessage": "User cancelled",
          "erroredOnUtc": "2022-10-27T09:53:29.000Z",
          "status": "Active"
        }
      ]
    }
  }
}

New event types

Codat supports a wide range of event types. See Webhook event types to review all available events.

Who is this relevant for?

Any client currently using our webhooks or clients looking to improve completion rates of their connection flows through calls to action.

How to get started?

• Already using our legacy rules webhooks? Learn how to migrate to new event types.
• Implementing webhooks for the first time? Learn how to use our webhook service.