Event Payload

The payload delivered to your webhook url will contain information about the fired event.

The payload attributes and types are defined below.

Attribute

Type

Description

resource

string

The resources affected by this event. Refer here for resource types available.

eventType

string

It describes the CRUD format of event .

Example: POST ,PUT etc.

eventSubType

string

This defines the event verb specifically for an event Type. Refer Observable Events for the defined event subtypes.

version

string

It is used for versioning the Events.

accountSlug

string

It defined the account which has generated the event

accountId

number

It defines the id of the account which has generated the event

responseData

object

This object can differ for different events. It contains metadata about the event.

Sample Json

{
   "resource": "fee_rule",
   "eventType": "POST",
   "eventSubType": "created",
   "accountSlug": "KapasKraft",
   "accountId": "1",
   "version": "v1",
   "responseData": {
       "userName": "Kapas Kraft",
       "portalId": "1",
       "portalName": "Amazon",
       "feeType": "Commission fee",
       "validFrom": "Friday 23 Aug 2019",
       "validTo": "Friday 23 Aug 2019",
       "clientId": "1",
       "feeId": "123",
       "feeVersion": "77",
       "requestType":"0",
       "emailTo": {
           "John Doe": "johndoe@gmail.com"
       },
       "noteUrl": "https://auth.auperator.co/settings/fees-details/portalId/feeId/feeVersion",
       "actionButton1Url":"https://auth.auperator.co/settings/fees-details/3/29/1.2",
       "actionButton2Url":"https://auth.auperator.co/settings/transaction-rule-add"
   }
}

Last updated