Get Events Response

  • success
    Type: boolean
    required

    Indicates whether this Events API request was processed without error.

  • error
    Type: object

    Only present when 'success' is false. A JSON object containing the error details. See Error Codes List

    Properties: 2
  • events
    Type: array of object

    Present when 'success' is true

    Properties: 2
  • last_event
    Type: string

    Present when 'success' is true. The last event reference in this response. Will be set to the value of your supplied last_event query string argument if no newer events are found. Should be used as a pointer to fetch the next set as follows ?last_event=1.106.1692874379.2

  • last_event_time
    Type: string

    Present when 'success' is true. The time of the last event in the returned set of events.

  • num_rows
    Type: integer

    Present when 'success' is true. The number of events returned in this response.

Examples 
{
  "events": [
    {
      "metadata": {
        "event_id": "1.106.1692926344.8",
        "webhook_delivered": true,
        "payload_format": "mobile-money"
      },
      "payload": {
        "reference": "1.106.1692926344.9",
        "accountname": "string",
        "amount": "10000",
        "amounttype": "centile",
        "channel": "KENYA.SAFARICOM",
        "currency": "KES",
        "customerreference": "ref101",
        "date": "2023-08-25T01:19:04Z",
        "mac": "string",
        "msisdn": "254000000001",
        "operatorreference": "string",
        "sourcereference": "1.106.1692926344.8",
        "success": "true",
        "target": "000001",
        "type": "notification"
      }
    }
  ],
  "last_event": "1.106.1692926344.8",
  "last_event_time": "2023-08-25T01:19:04Z",
  "num_rows": 1,
  "success": true
}