Webhook APIs

{ "swagger": "2.0", "info": { "version": "", "contact": {} }, "consumes": [ "application/json" ], "produces": [ "application/json" ], "paths": { "api/v1/ifi/{ifiID}/registerWebhookSubscription": { "post": { "tags": [ "Webhook APIs" ], "description": "This endpoint allows you to register a webhook to receive event notifications in the business process flow. Below is a list of all supported events that you can subscribe to: <ul><li>Payment events</li> <li>Resource events</li> <li>Form factor events</li><li>Card embossing events</li><li>Account events</li><li>Account transfer events</li><li>Policy events</li> </ul> For more information, see [Fusion Events](https://docs.zetaapps.in/display/fusion/Fusion+Events).", "operationId": "paymentTransactionsWebhookSubscribe", "parameters": [ { "name": "ifiID", "in": "path", "description": "ID of the IFI.", "required": true, "type": "string" }, { "in": "body", "name": "registerWebhookSubscriptionRequest", "description": "Specify the webhook subscription details", "required": true, "schema": { "$ref": "#/definitions/RegisterWebhookSubscriptionRequest" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized", }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found", } }, "summary": "Subscribe for a webhook event" } }, }, "definitions": { "RegisterWebhookSubscriptionRequest": { "type": "object", "properties": { "subscriptionID": { "type": "string", "description": "Unique identifier of the event subscription", "example": "aki98dfsb-asdnkj3eoqh-006kgur" }, "topic": { "type": "string", "description": "Fintech-specific object to which the event is emitted from a business logic ", "example": "_tenant_140827_RESOURCE" }, "webhookURL": { "type": "string", "description": "Webhook endpoint to handle incoming webhook messages", "example": "https://ptsv2.com/t/gffrp-1595524776/post" }, "secret": { "type": "string", "description": "Secret token to validate the incoming webhook message. Zeta will share a secret token", "example": "Yjc3MDkxN2VkOWYzZmIzMjNkMjg1mQuC" } } } }, }