Webhooks/Callbacks

Overview

Webhooks can be used to keep external / third party systems informed of activities that happen withing the Pyxis system.

For example, a webhook could be created that will inform a CRM system when a new customer has been on boarded by the Pyxis system.

To create a new webhook, post to the /api/webhooks endpoint with a request body containing the following data:

Name	Description	Type
enabled	Specifies whether the webhook should be triggered.	boolean
trigger	The id of the event that should trigger the webhook	nFiniti Event Id (see below)
eventType		Webhook
definition	The url to be called when the event type specified by 'trigger' occurs.	string

Event Id	Event Name	Description
1	Customer Created
2	Customer Creation Failed
3	KYC Succeeded
4	KYC Failed
5	Vault Creation Success
6	Vault Creation Failed
8	Funding Source Creation Succeeded
9	Funding Source Creation Failed,
11	Fund Transfer Succeeded,
12	Fund Transfer Failed,
13	Asset Ownership Transfer Success
14	Asset Ownership Transfer Failure
15	All
16	Payment Succeeded
17	Payment Failed,
18	Payment Intitiated,
19	Asset Ownership Intitiated,
20	Payment Pending,
21	Asset Created,
22	Asset Completed,
23	Asset Creation Failed,
27	Asset Ownership Deleted
100	Asset Status Changed