Webhook Event Types

The following events can be configured for delivery to the url specified in the webhook subscription via an HTTP post.

Webhook Message Object

Property	Type	Description
event_type	string	Name of event
event_id	string	Uniquely identifies the event.
merchant_id	integer	Unique id of PaySimple merchant associated with the event.
created_at	datetime	UTC date and time event was created in ISO-8601 format
data	object	Event message body
client_id	string	Deprecated. Use merchant_id. Unique id of PaySimple merchant associated with the event.

Customer Events

customer_created

Sent when a new customer record is created.

{
  "event_type": "customer_created",
  "event_id": "evt_5b2aca473b6325b3b4d22ed1",
  "merchant_id": 1225,
  "created_at": "2018-06-20T21:42:31.5412011Z",
  "data": {
    "customer_id": 8053900,
    "first_name": "John",
    "last_name": "Doe",
    "email": "[email protected]"
  }
}

customer_updated

Sent when a customer record details are modified. This event is not sent when payment methods are created or updated for a customer.

{
  "event_type": "customer_updated",
  "event_id": "evt_5b2aca473b6325b3b4d22ed1",
  "merchant_id": 1225,
  "created_at": "2018-06-20T21:42:31.5412011Z",
  "data": {
    "customer_id": 8053900,
    "first_name": "John",
    "last_name": "Doe",
    "email": "[email protected]"
  }
}

customer_deleted

Sent when a customer record is deleted.

{
  "event_type": "customer_deleted",
  "event_id": "evt_5b2aca473b6325b3b4d22ed1",
  "merchant_id": 1225,
  "created_at": "2018-06-20T21:42:31.5412011Z",
  "data": {
    "customer_id": 8053900
  }
}

Offering Events

offering_created

Sent when a new product or service is created in the catalog.

{
  "event_type": "offering_created",
  "merchant_id": 1225,
  "event_id": "evt_5b2ad1043b6325aa54da13af",
  "created_at": "2018-06-20T22:11:16.0994208Z",
  "data": {
    "offering_id": "5b2ad104253bb5aff8af67be"
  }
}

offering_updated

Sent when a product or service is modified in the catalog.

{
  "event_type": "offering_updated",
  "merchant_id": 1225,
  "event_id": "evt_5b2ad1043b6325aa54da13af",
  "created_at": "2018-06-20T22:11:16.0994208Z",
  "data": {
    "offering_id": "5b2ad104253bb5aff8af67be"
  }
}

offering_deleted

Sent when a product or service is removed from the catalog.

{
  "event_type": "offering_deleted",
  "merchant_id": 1225,
  "event_id": "evt_5b2ad1043b6325aa54da13af",
  "created_at": "2018-06-20T22:11:16.0994208Z",
  "data": {
    "offering_id": "5b2ad104253bb5aff8af67be"
  }
}