Customer Onboarding Data Direct: Real-Time
Data Direct: Real-Time delivers event information to your custom-built webhook in near real-time. Apiture needs information about your webhook in order to send data to it in the format that works best for you to process. Apiture’s Developer Portal allows you to provide and manage your webhook information on your schedule.
This will walk you through the steps needed to get your Data Direct: Real-Time webhook registered and sent data.
You must have already signed a contract for Data Direct:Real-Time to complete these steps. Apiture will reach out to you as it is time to perform these steps, which may take some time depending on if you are new to Apiture or to the Developer Portal.
Create Developer Portal Accounts
You may create a Developer Portal account at any time, even if you have never done business with Apiture before. However, you will not be able to use your account with actual data until further onboarding has begun.
At least one representative contact from the FI or the third-party who developed the webhook will need to create a developer portal account.
You will be asked for several pieces of information, including for contacts who can approve any changes made to the webhook registration. Click here for more information on Registration
Create an API Digital Banking Application that uses Data Direct: Real-Time
Data Direct: Real-Time automatically comes with the Event History API. The Event History API is used to recover when the Webhook encounters failures, but can also be used as desired to organize data or look through event history.
It is best to register for the API as you register for Data Direct: Real-Time; however, it is not required.
When creating the API Digital Banking application, the user must select the product Data Direct: Real-Time.
Click here for instructions on how to create an API application in the Developer Portal.
Create a Webhook Application
Webhook information, including authentication information and the webhook’s location, is managed on the Developer Portal. The FI or third-party developing the webhook must create a webhook application in the Developer Portal in order to have event data sent to it.
Instructions on how to create and register a webhook application are available in the Developer Portal Documentation.
The webhook can be created by one member of the Fi or third-party developer. Additional accounts can be added as owners of the webhook, granting them access to edit the webhook information when needed. For more information about ownership, see the Application Owners article.
Test the Webhook
Apiture is able to send event data to the webhook at this time. The FI or third-party should ensure their webhook is receiving data properly.
When the webhook was created, it was registered to receive events from specific event categories. A person from the FI or third-party should trigger an event belonging to that event category, and check that the webhook processes the event correctly.
For example, if the webhook will receive Authentication events, the person testing should log into Apiture Digital Banking and then see if events were received.
Questions
Apiture is glad to provide assistance with any questions you may have about the developer portal or the data sent by Data Direct: Real-Time. Reach out to your Apiture contact, and they will be happy to point you in the right direction.