Event Object

Example

{
  "event": {
      "type": "donation_created",
      "timestamp": "2020-11-19T17:11:58.708926Z"
      ... other infromation about the event ...
  },
  "signature": {
    "algorithm": "ed25519",
    "encoding": "base16",
    "publicKey": "7745859AD1E4C2230CFB5BF72F5DCCAA263E8560F6F6673A9FCD8434B92A7896",
    "signature": "3BCC7143161CFD5ABC2210A09768345C3CF89728FD2D834D6F8429FB6AB5FD7240C3AE2E494B936451601ECA9278A344173466FCA1EC2D180421FAB8401AC004"
  }
}

Description

Every event contains a signature over the json object present under the key event in a JWT format (canonical form) and all necessary information to verify the signature under the json key signature.

name	type	always present	description
event	Object	☑	JSON representation of the event
event.type	String	☑	String describing the event type
event.timestamp	integer	☑	Standard timestamp value in seconds

The fields present inside the signature key have the following meaning:

name	type	always present	description
algorithm	String	☑	algorithm used for the digital signature (currently, is always ed25519)
encoding	String	☑	the encoding type of the publicKey and signature fields (currently, is always base16)
publicKey	String	☑	the public key used to sign the notification event, in a format described by encoding
signature	String	☑	the signature over the notification event, in a format described by encoding

All event types

name	details
subscription_created	Subscription Created
subscription_canceled	Subscription Canceled
subscription_reactivated	Subscription Reactivated
subscription_finished	Subscription Finished
subscription_unpaid	Subscription Unpaid
payment_created	Payment Created
payment_refunded	Payment Refunded