Webhook for TFF Notifications (v1.0.1)

Download OpenAPI specification:Download

This interface should be implemented by the subscribers wishing to receive notifications from TFF via API.

In order to start receiving notifications, the consumer must subscribe to the desired event type

Notification Webhook

The consumer must implement this method to receieve notifications from TFF. The payload of this event will be specific to the event type.

x-api-key	string Used to pass a shared secret with each API request
X-Transaction-Id	string Represents the unique message identifier associated with the transaction (when available).

eventId required	string A numeric value assigned to the event. This is a monotonously increasing number over all notification events of the same type for the same subscription. Any gaps in the eventId number sequence indicate a lost message.
eventTimestamp required	string <date-time> The date and time this event notification was issued.
eventType required	string The event type for this notification. The subscriber should chose the type when they create a subscription.
message required	object Contains core attributes of the event object. The schema ob this object is specific to the event type. Generally these attributes can be used in subscription filters.
payload required	object The full payload of the event. The schema of this object is specific to the event type.

Content type

application/json

{"eventId": "1156",
"eventTimestamp": "2019-08-24T14:15:22Z",
"eventType": "string",
"message": { },
"payload": { }
}