Event API

The Event API allows you to retrieve events generated on your account. Events (such as the creation of a new customer or the reversal of a charge) trigger HTTP POST requests or "WebHooks" from Omise servers allowing for more flexible automation. For more information on which events are supported, see the WebHooks documentation.

Events are always serialized according to your account version as of the time of the event trigger regardless of the version specified in the triggering request.

Attributes

Name Type Description
object string

The string event.

id object_id

The event identifier matching /evnt(_test)?_[0-9a-z]+/.

livemode boolean

Whether this is a live (true) or test (false) event.

location string

API path to retrieve the current event object.

created_at datetime

UTC datetime of event creation in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ).

data object

Object associated with the triggered event.

key string

Event details (e.g. charge.create).

Example

  • JSON Response

List events

- GET https://api.omise.co/events

Returns a list of events belonging to your account.

Request Parameters

Name Type Description
from datetime

(optional, default: 1970-01-01T00:00:00Z) Earliest UTC datetime for returned records in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ).

limit integer

(optional, default: 20, maximum: 100) Number of records returned.

offset integer

(optional, default: 0) Offset of the first record returned (i.e. how many records to skip from the beginning).

order string

(optional, default: chronological) Order of records returned. One of chronological (earliest to latest) or reverse_chronological (latest to earliest).

to datetime

(optional, default: current UTC datetime) Latest UTC datetime for returned records in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ).

Example

  • List all events

Retrieve an event

- GET https://api.omise.co/events/{id}

Returns the event matching :id.

Example

  • Retrieve an event