Color mode

DjaoApp Notifications Reference

These are notifications sent by DjaoApp.

You can edit the notification e-mail templates in the Themes dashboard page .

Alphabetical

Card expires soon

This notification is sent when a credit card on file is about to expire.

Definition

event

"card_expires_soon"

broker

object

Site on which the product is hosted

slug

string

Unique identifier shown in the URL bar

printable_name

string

Name that can be safely used for display in HTML pages

picture

string

URL location of the profile picture

type

string

One of 'organization', 'personal' or 'user'

credentials

string

True if the account has valid login credentials

created_at

string

Date/time of creation (in ISO format)

full_name

string

Full name

string

E-mail address

phone

string

Phone number

street_address

string

Street address

locality

string

City/Town

region

string

State/Province/County

postal_code

string

Zip/Postal code

country

string

Country as 2-letter code (ISO 3166-1)

default_timezone

string

Timezone to use when reporting metrics

is_provider

boolean

The profile can fulfill the provider side of a subscription.

is_bulk_buyer

boolean

Enable GroupBuy

extra

string

Extra meta data (can be stringify JSON)

detail

string

Describes the result of the action in human-readable form

nick_name

string

Short casual name used to address the contact (only available for 'personal' and 'user' accounts)

lang

string

Preferred communication language (only available for 'personal' and 'user' accounts)

back_url

string

Link back to the site

profile

object

profile the notification relates to

slug

string

Unique identifier shown in the URL bar

printable_name

string

Name that can be safely used for display in HTML pages

picture

string

URL location of the profile picture

type

string

One of 'organization', 'personal' or 'user'

credentials

string

True if the account has valid login credentials

created_at

string

Date/time of creation (in ISO format)

full_name

string

Full name

string

E-mail address

phone

string

Phone number

street_address

string

Street address

locality

string

City/Town

region

string

State/Province/County

postal_code

string

Zip/Postal code

country

string

Country as 2-letter code (ISO 3166-1)

default_timezone

string

Timezone to use when reporting metrics

is_provider

boolean

The profile can fulfill the provider side of a subscription.

is_bulk_buyer

boolean

Enable GroupBuy

extra

string

Extra meta data (can be stringify JSON)

detail

string

Describes the result of the action in human-readable form

nick_name

string

Short casual name used to address the contact (only available for 'personal' and 'user' accounts)

lang

string

Preferred communication language (only available for 'personal' and 'user' accounts)

nb_expiration_days

integer

number of days before the card expires

last4

string

Last 4 digits of the credit card on file

exp_date

string

Expiration date of the credit card on file

Examples

{
  "event": "card_expires_soon",
  "broker": {
    "slug": "djaoapp",
    "printable_name": "DjaoApp",
    "full_name": "DjaoApp inc.",
    "nick_name": "DjaoApp",
    "picture": null,
    "type": "organization",
    "credentials": false,
    "created_at": "2024-01-01T00:00:00Z",
    "email": "djaoapp@localhost.localdomain",
    "phone": "415-555-5555",
    "street_address": "1 SaaS Road",
    "locality": "San Francisco",
    "region": "California",
    "postal_code": "94133",
    "country": "US",
    "default_timezone": "America/Los_Angeles",
    "is_provider": true,
    "is_bulk_buyer": false,
    "lang": "en",
    "extra": null
  },
  "back_url": "http://localhost:8020",
  "profile": {
    "slug": "xia",
    "printable_name": "Xia",
    "full_name": "Xia Lee",
    "nick_name": "Xia",
    "picture": null,
    "type": "personal",
    "credentials": true,
    "created_at": "2024-01-01T00:00:00Z",
    "email": "xia@localhost.localdomain",
    "phone": "415-555-5556",
    "street_address": "1 SaaS Road",
    "locality": "San Francisco",
    "region": "California",
    "postal_code": "94133",
    "country": "US",
    "default_timezone": "America/Los_Angeles",
    "is_provider": false,
    "is_bulk_buyer": false,
    "lang": "en",
    "extra": null
  },
  "last4": "4242",
  "exp_date": "07/2023",
  "nb_expiration_days": 15
}

Card updated

This notification is sent when a credit card on file is updated.

Definition

event

"card_updated"

broker

object

Site on which the product is hosted

slug

string

Unique identifier shown in the URL bar

printable_name

string

Name that can be safely used for display in HTML pages

picture

string

URL location of the profile picture

type

string

One of 'organization', 'personal' or 'user'

credentials

string

True if the account has valid login credentials

created_at

string

Date/time of creation (in ISO format)

full_name

string

Full name

string

E-mail address

phone

string

Phone number

street_address

string

Street address

locality

string

City/Town

region

string

State/Province/County

postal_code

string

Zip/Postal code

country

string

Country as 2-letter code (ISO 3166-1)

default_timezone

string

Timezone to use when reporting metrics

is_provider

boolean

The profile can fulfill the provider side of a subscription.

is_bulk_buyer

boolean

Enable GroupBuy

extra

string

Extra meta data (can be stringify JSON)

detail

string

Describes the result of the action in human-readable form

nick_name

string

Short casual name used to address the contact (only available for 'personal' and 'user' accounts)

lang

string

Preferred communication language (only available for 'personal' and 'user' accounts)

back_url

string

Link back to the site

profile

object

profile the notification relates to

slug

string

Unique identifier shown in the URL bar

printable_name

string

Name that can be safely used for display in HTML pages

picture

string

URL location of the profile picture

type

string

One of 'organization', 'personal' or 'user'

credentials

string

True if the account has valid login credentials

created_at

string

Date/time of creation (in ISO format)

full_name

string

Full name

string

E-mail address

phone

string

Phone number

street_address

string

Street address

locality

string

City/Town

region

string

State/Province/County

postal_code

string

Zip/Postal code

country

string

Country as 2-letter code (ISO 3166-1)

default_timezone

string

Timezone to use when reporting metrics

is_provider

boolean

The profile can fulfill the provider side of a subscription.

is_bulk_buyer

boolean

Enable GroupBuy

extra

string

Extra meta data (can be stringify JSON)

detail

string

Describes the result of the action in human-readable form

nick_name

string

Short casual name used to address the contact (only available for 'personal' and 'user' accounts)

lang

string

Preferred communication language (only available for 'personal' and 'user' accounts)

originated_by

object

the user at the origin of the notification

slug

string

Unique identifier that can safely be used in place of username

username

string

Unique identifier for the user, typically used in URLs

printable_name

string

Name that can be safely used for display in HTML pages

picture

string

URL location of the profile picture

string

Primary e-mail address to contact user

phone

string

Primary phone number to contact user

full_name

string

Full name (effectively first name followed by last name)

nick_name

string

Short casual name used to address the user

lang

string

Preferred communication language

credentials

string

True if the user has valid login credentials

otp_enabled

string

True if the user has valid login credentials

created_at

string

Date at which the user account was created

last_login

string

Date at which the user last logged in

email_code

integer

Email verification code

phone_code

integer

Phone verification code

changes

object

changes to the profile

Examples

{
  "event": "card_updated",
  "broker": {
    "slug": "djaoapp",
    "printable_name": "DjaoApp",
    "full_name": "DjaoApp inc.",
    "nick_name": "DjaoApp",
    "picture": null,
    "type": "organization",
    "credentials": false,
    "created_at": "2024-01-01T00:00:00Z",
    "email": "djaoapp@localhost.localdomain",
    "phone": "415-555-5555",
    "street_address": "1 SaaS Road",
    "locality": "San Francisco",
    "region": "California",
    "postal_code": "94133",
    "country": "US",
    "default_timezone": "America/Los_Angeles",
    "is_provider": true,
    "is_bulk_buyer": false,
    "lang": "en",
    "extra": null
  },
  "back_url": "http://localhost:8020",
  "originated_by": {
    "slug": "xia",
    "username": "xia",
    "printable_name": "Xia",
    "full_name": "Xia Lee",
    "nick_name": "Xia",
    "picture": null,
    "type": "personal",
    "credentials": true,
    "created_at": "2024-01-01T00:00:00Z",
    "last_login": "2024-01-01T00:00:00Z",
    "email": "xia@localhost.localdomain",
    "phone": "415-555-5556",
    "lang": "en",
    "extra": null
  },
  "profile": {
    "slug": "xia",
    "printable_name": "Xia Lee",
    "full_name": "Xia Lee",
    "nick_name": "Xia",
    "picture": null,
    "type": "personal",
    "credentials": true,
    "created_at": "2024-01-01T00:00:00Z",
    "email": "xia@localhost.localdomain",
    "phone": "415-555-5555",
    "street_address": "1 SaaS Road",
    "locality": "San Francisco",
    "region": "California",
    "postal_code": "94133",
    "country": "US",
    "default_timezone": "America/Los_Angeles",
    "is_provider": true,
    "is_bulk_buyer": false,
    "lang": "en",
    "extra": null
  },
  "changes": {
    "last4": {
      "pre": "4674",
      "post": "4242"
    },
    "exp_date": {
      "pre": "07/2024",
      "post": "07/2023"
    }
  }
}

Charge receipt

This notification is sent when a charge is created on a credit card. It is also sent when the charge is refunded.

Definition

event

"charge_updated"

broker

object

Site on which the product is hosted

slug

string

Unique identifier shown in the URL bar

printable_name

string

Name that can be safely used for display in HTML pages

picture

string

URL location of the profile picture

type

string

One of 'organization', 'personal' or 'user'

credentials

string

True if the account has valid login credentials

created_at

string

Date/time of creation (in ISO format)

full_name

string

Full name

string

E-mail address

phone

string

Phone number

street_address

string

Street address

locality

string

City/Town

region

string

State/Province/County

postal_code

string

Zip/Postal code

country

string

Country as 2-letter code (ISO 3166-1)

default_timezone

string

Timezone to use when reporting metrics

is_provider

boolean

The profile can fulfill the provider side of a subscription.

is_bulk_buyer

boolean

Enable GroupBuy

extra

string

Extra meta data (can be stringify JSON)

detail

string

Describes the result of the action in human-readable form

nick_name

string

Short casual name used to address the contact (only available for 'personal' and 'user' accounts)

lang

string

Preferred communication language (only available for 'personal' and 'user' accounts)

back_url

string

Link back to the site

profile

object

profile the notification relates to

slug

string

Unique identifier shown in the URL bar

printable_name

string

Name that can be safely used for display in HTML pages

picture

string

URL location of the profile picture

type

string

One of 'organization', 'personal' or 'user'

credentials

string

True if the account has valid login credentials

created_at

string

Date/time of creation (in ISO format)

full_name

string

Full name

string

E-mail address

phone

string

Phone number

street_address

string

Street address

locality

string

City/Town

region

string

State/Province/County

postal_code

string

Zip/Postal code

country

string

Country as 2-letter code (ISO 3166-1)

default_timezone

string

Timezone to use when reporting metrics

is_provider

boolean

The profile can fulfill the provider side of a subscription.

is_bulk_buyer

boolean

Enable GroupBuy

extra

string

Extra meta data (can be stringify JSON)

detail

string

Describes the result of the action in human-readable form

nick_name

string

Short casual name used to address the contact (only available for 'personal' and 'user' accounts)

lang

string

Preferred communication language (only available for 'personal' and 'user' accounts)

originated_by

object

the user at the origin of the notification

slug

string

Unique identifier that can safely be used in place of username

username

string

Unique identifier for the user, typically used in URLs

printable_name

string

Name that can be safely used for display in HTML pages

picture

string

URL location of the profile picture

string

Primary e-mail address to contact user

phone

string

Primary phone number to contact user

full_name

string

Full name (effectively first name followed by last name)

nick_name

string

Short casual name used to address the user

lang

string

Preferred communication language

credentials

string

True if the user has valid login credentials

otp_enabled

string

True if the user has valid login credentials

created_at

string

Date at which the user account was created

last_login

string

Date at which the user last logged in

email_code

integer

Email verification code

phone_code

integer

Phone verification code

provider

object

provider when different from broker

slug

string

Unique identifier shown in the URL bar

printable_name

string

Name that can be safely used for display in HTML pages

picture

string

URL location of the profile picture

type

string

One of 'organization', 'personal' or 'user'

credentials

string

True if the account has valid login credentials

created_at

string

Date/time of creation (in ISO format)

full_name

string

Full name

string

E-mail address

phone

string

Phone number

street_address

string

Street address

locality

string

City/Town

region

string

State/Province/County

postal_code

string

Zip/Postal code

country

string

Country as 2-letter code (ISO 3166-1)

default_timezone

string

Timezone to use when reporting metrics

is_provider

boolean

The profile can fulfill the provider side of a subscription.

is_bulk_buyer

boolean

Enable GroupBuy

extra

string

Extra meta data (can be stringify JSON)

detail

string

Describes the result of the action in human-readable form

nick_name

string

Short casual name used to address the contact (only available for 'personal' and 'user' accounts)

lang

string

Preferred communication language (only available for 'personal' and 'user' accounts)

charge_items

array

the line items on the charge receipt

refunded

array

Array of transactions with refunds

created_at

string

Date/time of creation (in ISO format)

description

string

Free-form text description for the transaction

amount

string

Amount being transfered

is_debit

string

True if the transaction is indentified as a debit in the API context

orig_account

string

Source account from which funds are withdrawn

orig_profile

object

Billing profile from which funds are withdrawn

slug

string

Unique identifier shown in the URL bar

printable_name

string

Name that can be safely used for display in HTML pages

picture

string

URL location of the profile picture

type

string

One of 'organization', 'personal' or 'user'

credentials

string

True if the account has valid login credentials

created_at

string

Date/time of creation (in ISO format)

orig_amount

integer

Amount withdrawn from source in orig_unit

orig_unit

string

Three-letter ISO 4217 code for source currency unit (ex: usd)

dest_account

string

Target account to which funds are deposited

dest_profile

object

Billing profile to which funds are deposited

slug

string

Unique identifier shown in the URL bar

printable_name

string

Name that can be safely used for display in HTML pages

picture

string

URL location of the profile picture

type

string

One of 'organization', 'personal' or 'user'

credentials

string

True if the account has valid login credentials

created_at

string

Date/time of creation (in ISO format)

dest_amount

integer

Amount deposited into target in dest_unit

dest_unit

string

Three-letter ISO 4217 code for target currency unit (ex: usd)

charge_total

object

Total amount for the charge after refunds have been applied

amount

integer

amount in unit

unit

string

Three-letter ISO 4217 code for currency unit (ex: usd)

charge

object

the charge that relates to the notification

created_at

string

Date/time of creation (in ISO format)

amount

integer

Total amount in currency unit

unit

string

Three-letter ISO 4217 code for currency unit (ex: usd)

state

string

Current state (i.e. created, done, failed, disputed)

readable_amount

string

Amount and unit in a commonly accepted readable format

description

string

Description for the charge as appears on billing statements

claim_code

string

Unique code used to retrieve the invoice / charge

last4

string

Last 4 digits of the credit card used

exp_date

string

Expiration date of the credit card used

processor_key

string

Unique identifier returned by the payment processor

detail

string

Feedback for the user in plain text

Examples

{
  "event": "charge_updated",
  "broker": {
    "slug": "djaoapp",
    "printable_name": "DjaoApp",
    "full_name": "DjaoApp inc.",
    "nick_name": "DjaoApp",
    "picture": null,
    "type": "organization",
    "credentials": false,
    "created_at": "2024-01-01T00:00:00Z",
    "email": "djaoapp@localhost.localdomain",
    "phone": "415-555-5555",
    "street_address": "1 SaaS Road",
    "locality": "San Francisco",
    "region": "California",
    "postal_code": "94133",
    "country": "US",
    "default_timezone": "America/Los_Angeles",
    "is_provider": true,
    "is_bulk_buyer": false,
    "lang": "en",
    "extra": null
  },
  "back_url": "http://localhost:8020",
  "profile": {
    "slug": "xia",
    "printable_name": "Xia",
    "full_name": "Xia Lee",
    "nick_name": "Xia",
    "picture": null,
    "type": "personal",
    "credentials": true,
    "created_at": "2024-01-01T00:00:00Z",
    "email": "xia@localhost.localdomain",
    "phone": "415-555-5556",
    "street_address": "1 SaaS Road",
    "locality": "San Francisco",
    "region": "California",
    "postal_code": "94133",
    "country": "US",
    "default_timezone": "America/Los_Angeles",
    "is_provider": false,
    "is_bulk_buyer": false,
    "lang": "en",
    "extra": null
  },
  "originated_by": {
    "slug": "xia",
    "username": "xia",
    "printable_name": "Xia",
    "full_name": "Xia Lee",
    "nick_name": "Xia",
    "picture": null,
    "type": "personal",
    "credentials": true,
    "created_at": "2024-01-01T00:00:00Z",
    "last_login": "2024-01-01T00:00:00Z",
    "email": "xia@localhost.localdomain",
    "phone": "415-555-5556",
    "lang": "en",
    "extra": null
  },
  "charge_items": [
    {
      "invoiced": {
        "created_at": "2024-01-01T00:00:00Z",
        "description": "subscription to premium",
        "amount": 11900,
        "is_debit": false,
        "orig_account": "Receivable",
        "orig_profile": {
          "slug": "djaoapp",
          "printable_name": "DjaoApp",
          "picture": null,
          "type": "organization",
          "credentials": false
        },
        "orig_amount": 11900,
        "orig_unit": "usd",
        "dest_account": "Payable",
        "dest_profile": {
          "slug": "xia",
          "printable_name": "Xia",
          "picture": null,
          "type": "personal",
          "credentials": true
        },
        "dest_amount": 11900,
        "dest_unit": "usd"
      },
      "refunded": []
    }
  ],
  "charge": {
    "created_at": "2024-01-01T00:00:00Z",
    "amount": 11900,
    "unit": "usd",
    "readable_amount": "$119.00",
    "description": "subscription to premium",
    "last4": "4242",
    "exp_date": "07/2023",
    "processor_key": "ch_abc123",
    "state": "done"
  },
  "provider": {
    "slug": "djaoapp",
    "printable_name": "DjaoApp",
    "full_name": "DjaoApp inc.",
    "nick_name": "DjaoApp",
    "picture": null,
    "type": "organization",
    "credentials": false,
    "created_at": "2024-01-01T00:00:00Z",
    "email": "djaoapp@localhost.localdomain",
    "phone": "415-555-5555",
    "street_address": "1 SaaS Road",
    "locality": "San Francisco",
    "region": "California",
    "postal_code": "94133",
    "country": "US",
    "default_timezone": "America/Los_Angeles",
    "is_provider": true,
    "is_bulk_buyer": false,
    "lang": "en",
    "extra": null
  }
}

Claim code

This notification is sent to the user invited through a groupBuy.

Definition

event

"claim_code_generated"

broker

object

Site on which the product is hosted

slug

string

Unique identifier shown in the URL bar

printable_name

string

Name that can be safely used for display in HTML pages

picture

string

URL location of the profile picture

type

string

One of 'organization', 'personal' or 'user'

credentials

string

True if the account has valid login credentials

created_at

string

Date/time of creation (in ISO format)

full_name

string

Full name

string

E-mail address

phone

string

Phone number

street_address

string

Street address

locality

string

City/Town

region

string

State/Province/County

postal_code

string

Zip/Postal code

country

string

Country as 2-letter code (ISO 3166-1)

default_timezone

string

Timezone to use when reporting metrics

is_provider

boolean

The profile can fulfill the provider side of a subscription.

is_bulk_buyer

boolean

Enable GroupBuy

extra

string

Extra meta data (can be stringify JSON)

detail

string

Describes the result of the action in human-readable form

nick_name

string

Short casual name used to address the contact (only available for 'personal' and 'user' accounts)

lang

string

Preferred communication language (only available for 'personal' and 'user' accounts)

back_url

string

Link back to the site

profile

object

profile the notification relates to

slug

string

Unique identifier shown in the URL bar

printable_name

string

Name that can be safely used for display in HTML pages

picture

string

URL location of the profile picture

type

string

One of 'organization', 'personal' or 'user'

credentials

string

True if the account has valid login credentials

created_at

string

Date/time of creation (in ISO format)

full_name

string

Full name

string

E-mail address

phone

string

Phone number

street_address

string

Street address

locality

string

City/Town

region

string

State/Province/County

postal_code

string

Zip/Postal code

country

string

Country as 2-letter code (ISO 3166-1)

default_timezone

string

Timezone to use when reporting metrics

is_provider

boolean

The profile can fulfill the provider side of a subscription.

is_bulk_buyer

boolean

Enable GroupBuy

extra

string

Extra meta data (can be stringify JSON)

detail

string

Describes the result of the action in human-readable form

nick_name

string

Short casual name used to address the contact (only available for 'personal' and 'user' accounts)

lang

string

Preferred communication language (only available for 'personal' and 'user' accounts)

originated_by

object

the user at the origin of the notification

slug

string

Unique identifier that can safely be used in place of username

username

string

Unique identifier for the user, typically used in URLs

printable_name

string

Name that can be safely used for display in HTML pages

picture

string

URL location of the profile picture

string

Primary e-mail address to contact user

phone

string

Primary phone number to contact user

full_name

string

Full name (effectively first name followed by last name)

nick_name

string

Short casual name used to address the user

lang

string

Preferred communication language

credentials

string

True if the user has valid login credentials

otp_enabled

string

True if the user has valid login credentials

created_at

string

Date at which the user account was created

last_login

string

Date at which the user last logged in

email_code

integer

Email verification code

phone_code

integer

Phone verification code

provider

object

provider when different from broker

slug

string

Unique identifier shown in the URL bar

printable_name

string

Name that can be safely used for display in HTML pages

picture

string

URL location of the profile picture

type

string

One of 'organization', 'personal' or 'user'

credentials

string

True if the account has valid login credentials

created_at

string

Date/time of creation (in ISO format)

full_name

string

Full name

string

E-mail address

phone

string

Phone number

street_address

string

Street address

locality

string

City/Town

region

string

State/Province/County

postal_code

string

Zip/Postal code

country

string

Country as 2-letter code (ISO 3166-1)

default_timezone

string

Timezone to use when reporting metrics

is_provider

boolean

The profile can fulfill the provider side of a subscription.

is_bulk_buyer

boolean

Enable GroupBuy

extra

string

Extra meta data (can be stringify JSON)

detail

string

Describes the result of the action in human-readable form

nick_name

string

Short casual name used to address the contact (only available for 'personal' and 'user' accounts)

lang

string

Preferred communication language (only available for 'personal' and 'user' accounts)

cart_items

array

Line items paid for already

created_at

string

Date/time of creation (in ISO format)

user

object

User the cart belongs to

slug

string

Unique identifier that can safely be used in place of username

username

string

Unique identifier for the user, typically used in URLs

printable_name

string

Name that can be safely used for display in HTML pages

picture

string

URL location of the profile picture

plan

object

Plan in the cart

slug

string

Unique identifier shown in the URL bar

title

string

Title for the plan

use

object

Use charge in the cart

slug

string

Unique identifier shown in the URL bar

title

string

Short description of the use charge

description

string

Long description of the use charge

created_at

string

Date/time of creation (in ISO format)

use_amount

integer

Amount per unit defined by the provider of the use charge in plan currency unit (ex: $0.01/request)

quota

integer

Usage included in the plan (in units defined by the provider)

maximum_limit

integer

Maximum spend limit per period above which the subscriber is notified (in currency unit)

extra

string

Extra meta data (can be stringify JSON)

option

integer

Index in the list of discounts for advance payments

quantity

integer

Number of periods to be paid in advance

claim_code

string

Code used to assign the cart item to a user in group buy

sync_on

string

identifier of the person that will benefit from the subscription (GroupBuy)

full_name

string

Full name of the person that will benefit from the subscription (GroupBuy)

string

e-mail of the person that will benefit from the subscription (GroupBuy)

detail

string

Describes the result of the action in human-readable form

detail

string

Describes the result of the action in human-readable form

Examples

{
  "event": "claim_code_generated",
  "broker": {
    "slug": "djaoapp",
    "printable_name": "DjaoApp",
    "full_name": "DjaoApp inc.",
    "nick_name": "DjaoApp",
    "picture": null,
    "type": "organization",
    "credentials": false,
    "created_at": "2024-01-01T00:00:00Z",
    "email": "djaoapp@localhost.localdomain",
    "phone": "415-555-5555",
    "street_address": "1 SaaS Road",
    "locality": "San Francisco",
    "region": "California",
    "postal_code": "94133",
    "country": "US",
    "default_timezone": "America/Los_Angeles",
    "is_provider": true,
    "is_bulk_buyer": false,
    "lang": "en",
    "extra": null
  },
  "back_url": "http://localhost:8020",
  "profile": {
    "slug": "xia",
    "printable_name": "Xia",
    "full_name": "Xia Lee",
    "nick_name": "Xia",
    "picture": null,
    "type": "personal",
    "credentials": true,
    "created_at": "2024-01-01T00:00:00Z",
    "email": "xia@localhost.localdomain",
    "phone": "415-555-5556",
    "street_address": "1 SaaS Road",
    "locality": "San Francisco",
    "region": "California",
    "postal_code": "94133",
    "country": "US",
    "default_timezone": "America/Los_Angeles",
    "is_provider": false,
    "is_bulk_buyer": false,
    "lang": "en",
    "extra": null
  },
  "originated_by": {
    "slug": "xia",
    "username": "xia",
    "printable_name": "Xia",
    "full_name": "Xia Lee",
    "nick_name": "Xia",
    "picture": null,
    "type": "personal",
    "credentials": true,
    "created_at": "2024-01-01T00:00:00Z",
    "last_login": "2024-01-01T00:00:00Z",
    "email": "xia@localhost.localdomain",
    "phone": "415-555-5556",
    "lang": "en",
    "extra": null
  },
  "cart_items": [
    {
      "created_at": "2024-01-01T00:00:00Z",
      "user": {
        "slug": "emilie",
        "username": "emilie",
        "printable_name": "Emilie",
        "full_name": "Emilie Jolie",
        "nick_name": "Emilie",
        "picture": null,
        "type": "user",
        "credentials": false,
        "created_at": "2024-01-01T00:00:00Z",
        "last_login": null,
        "email": "emilie@localhost.localdomain",
        "phone": "415-555-5557",
        "lang": "en",
        "extra": null
      },
      "plan": {
        "slug": "premium",
        "title": "Premium"
      },
      "option": 1,
      "full_name": "Emilie Jolie",
      "sync_on": "emilie@localhost.localdomain",
      "email": "emilie@localhost.localdomain"
    }
  ],
  "provider": {
    "slug": "djaoapp",
    "printable_name": "DjaoApp",
    "full_name": "DjaoApp inc.",
    "nick_name": "DjaoApp",
    "picture": null,
    "type": "organization",
    "credentials": false,
    "created_at": "2024-01-01T00:00:00Z",
    "email": "djaoapp@localhost.localdomain",
    "phone": "415-555-5555",
    "street_address": "1 SaaS Road",
    "locality": "San Francisco",
    "region": "California",
    "postal_code": "94133",
    "country": "US",
    "default_timezone": "America/Los_Angeles",
    "is_provider": true,
    "is_bulk_buyer": false,
    "lang": "en",
    "extra": null
  }
}

Subscription expires soon

This notification is sent when a subscription is about to expire.

Definition

event

"expires_soon"

broker

object

Site on which the product is hosted

slug

string

Unique identifier shown in the URL bar

printable_name

string

Name that can be safely used for display in HTML pages

picture

string

URL location of the profile picture

type

string

One of 'organization', 'personal' or 'user'

credentials

string

True if the account has valid login credentials

created_at

string

Date/time of creation (in ISO format)

full_name

string

Full name

string

E-mail address

phone

string

Phone number

street_address

string

Street address

locality

string

City/Town

region

string

State/Province/County

postal_code

string

Zip/Postal code

country

string

Country as 2-letter code (ISO 3166-1)

default_timezone

string

Timezone to use when reporting metrics

is_provider

boolean

The profile can fulfill the provider side of a subscription.

is_bulk_buyer

boolean

Enable GroupBuy

extra

string

Extra meta data (can be stringify JSON)

detail

string

Describes the result of the action in human-readable form

nick_name

string

Short casual name used to address the contact (only available for 'personal' and 'user' accounts)

lang

string

Preferred communication language (only available for 'personal' and 'user' accounts)

back_url

string

Link back to the site

profile

object

profile the notification relates to

slug

string

Unique identifier shown in the URL bar

printable_name

string

Name that can be safely used for display in HTML pages

picture

string

URL location of the profile picture

type

string

One of 'organization', 'personal' or 'user'

credentials

string

True if the account has valid login credentials

created_at

string

Date/time of creation (in ISO format)

full_name

string

Full name

string

E-mail address

phone

string

Phone number

street_address

string

Street address

locality

string

City/Town

region

string

State/Province/County

postal_code

string

Zip/Postal code

country

string

Country as 2-letter code (ISO 3166-1)

default_timezone

string

Timezone to use when reporting metrics

is_provider

boolean

The profile can fulfill the provider side of a subscription.

is_bulk_buyer

boolean

Enable GroupBuy

extra

string

Extra meta data (can be stringify JSON)

detail

string

Describes the result of the action in human-readable form

nick_name

string

Short casual name used to address the contact (only available for 'personal' and 'user' accounts)

lang

string

Preferred communication language (only available for 'personal' and 'user' accounts)

plan

object

plan the subscription relates to

slug

string

Unique identifier shown in the URL bar

title

string

Title for the plan

provider

object

provider when different from broker

slug

string

Unique identifier shown in the URL bar

printable_name

string

Name that can be safely used for display in HTML pages

picture

string

URL location of the profile picture

type

string

One of 'organization', 'personal' or 'user'

credentials

string

True if the account has valid login credentials

created_at

string

Date/time of creation (in ISO format)

full_name

string

Full name

string

E-mail address

phone

string

Phone number

street_address

string

Street address

locality

string

City/Town

region

string

State/Province/County

postal_code

string

Zip/Postal code

country

string

Country as 2-letter code (ISO 3166-1)

default_timezone

string

Timezone to use when reporting metrics

is_provider

boolean

The profile can fulfill the provider side of a subscription.

is_bulk_buyer

boolean

Enable GroupBuy

extra

string

Extra meta data (can be stringify JSON)

detail

string

Describes the result of the action in human-readable form

nick_name

string

Short casual name used to address the contact (only available for 'personal' and 'user' accounts)

lang

string

Preferred communication language (only available for 'personal' and 'user' accounts)

nb_expiration_days

integer

number of days before the subscription expires

Examples

{
  "event": "expires_soon",
  "broker": {
    "slug": "djaoapp",
    "printable_name": "DjaoApp",
    "full_name": "DjaoApp inc.",
    "nick_name": "DjaoApp",
    "picture": null,
    "type": "organization",
    "credentials": false,
    "created_at": "2024-01-01T00:00:00Z",
    "email": "djaoapp@localhost.localdomain",
    "phone": "415-555-5555",
    "street_address": "1 SaaS Road",
    "locality": "San Francisco",
    "region": "California",
    "postal_code": "94133",
    "country": "US",
    "default_timezone": "America/Los_Angeles",
    "is_provider": true,
    "is_bulk_buyer": false,
    "lang": "en",
    "extra": null
  },
  "back_url": "http://localhost:8020",
  "profile": {
    "slug": "xia",
    "printable_name": "Xia",
    "full_name": "Xia Lee",
    "nick_name": "Xia",
    "picture": null,
    "type": "personal",
    "credentials": true,
    "created_at": "2024-01-01T00:00:00Z",
    "email": "xia@localhost.localdomain",
    "phone": "415-555-5556",
    "street_address": "1 SaaS Road",
    "locality": "San Francisco",
    "region": "California",
    "postal_code": "94133",
    "country": "US",
    "default_timezone": "America/Los_Angeles",
    "is_provider": false,
    "is_bulk_buyer": false,
    "lang": "en",
    "extra": null
  },
  "plan": {
    "slug": "premium",
    "title": "Premium"
  },
  "provider": {
    "slug": "djaoapp",
    "printable_name": "DjaoApp",
    "full_name": "DjaoApp inc.",
    "nick_name": "DjaoApp",
    "picture": null,
    "type": "organization",
    "credentials": false,
    "created_at": "2024-01-01T00:00:00Z",
    "email": "djaoapp@localhost.localdomain",
    "phone": "415-555-5555",
    "street_address": "1 SaaS Road",
    "locality": "San Francisco",
    "region": "California",
    "postal_code": "94133",
    "country": "US",
    "default_timezone": "America/Los_Angeles",
    "is_provider": true,
    "is_bulk_buyer": false,
    "lang": "en",
    "extra": null
  },
  "nb_expiration_days": 15
}

Order confirmation

This notification is sent when an order has been confirmed but a charge has not been successfully processed yet.

Definition

event

"order_executed"

broker

object

Site on which the product is hosted

slug

string

Unique identifier shown in the URL bar

printable_name

string

Name that can be safely used for display in HTML pages

picture

string

URL location of the profile picture

type

string

One of 'organization', 'personal' or 'user'

credentials

string

True if the account has valid login credentials

created_at

string

Date/time of creation (in ISO format)

full_name

string

Full name

string

E-mail address

phone

string

Phone number

street_address

string

Street address

locality

string

City/Town

region

string

State/Province/County

postal_code

string

Zip/Postal code

country

string

Country as 2-letter code (ISO 3166-1)

default_timezone

string

Timezone to use when reporting metrics

is_provider

boolean

The profile can fulfill the provider side of a subscription.

is_bulk_buyer

boolean

Enable GroupBuy

extra

string

Extra meta data (can be stringify JSON)

detail

string

Describes the result of the action in human-readable form

nick_name

string

Short casual name used to address the contact (only available for 'personal' and 'user' accounts)

lang

string

Preferred communication language (only available for 'personal' and 'user' accounts)

back_url

string

Link back to the site

profile

object

profile the notification relates to

slug

string

Unique identifier shown in the URL bar

printable_name

string

Name that can be safely used for display in HTML pages

picture

string

URL location of the profile picture

type

string

One of 'organization', 'personal' or 'user'

credentials

string

True if the account has valid login credentials

created_at

string

Date/time of creation (in ISO format)

full_name

string

Full name

string

E-mail address

phone

string

Phone number

street_address

string

Street address

locality

string

City/Town

region

string

State/Province/County

postal_code

string

Zip/Postal code

country

string

Country as 2-letter code (ISO 3166-1)

default_timezone

string

Timezone to use when reporting metrics

is_provider

boolean

The profile can fulfill the provider side of a subscription.

is_bulk_buyer

boolean

Enable GroupBuy

extra

string

Extra meta data (can be stringify JSON)

detail

string

Describes the result of the action in human-readable form

nick_name

string

Short casual name used to address the contact (only available for 'personal' and 'user' accounts)

lang

string

Preferred communication language (only available for 'personal' and 'user' accounts)

originated_by

object

the user at the origin of the notification

slug

string

Unique identifier that can safely be used in place of username

username

string

Unique identifier for the user, typically used in URLs

printable_name

string

Name that can be safely used for display in HTML pages

picture

string

URL location of the profile picture

string

Primary e-mail address to contact user

phone

string

Primary phone number to contact user

full_name

string

Full name (effectively first name followed by last name)

nick_name

string

Short casual name used to address the user

lang

string

Preferred communication language

credentials

string

True if the user has valid login credentials

otp_enabled

string

True if the user has valid login credentials

created_at

string

Date at which the user account was created

last_login

string

Date at which the user last logged in

email_code

integer

Email verification code

phone_code

integer

Phone verification code

provider

object

provider when different from broker

slug

string

Unique identifier shown in the URL bar

printable_name

string

Name that can be safely used for display in HTML pages

picture

string

URL location of the profile picture

type

string

One of 'organization', 'personal' or 'user'

credentials

string

True if the account has valid login credentials

created_at

string

Date/time of creation (in ISO format)

full_name

string

Full name

string

E-mail address

phone

string

Phone number

street_address

string

Street address

locality

string

City/Town

region

string

State/Province/County

postal_code

string

Zip/Postal code

country

string

Country as 2-letter code (ISO 3166-1)

default_timezone

string

Timezone to use when reporting metrics

is_provider

boolean

The profile can fulfill the provider side of a subscription.

is_bulk_buyer

boolean

Enable GroupBuy

extra

string

Extra meta data (can be stringify JSON)

detail

string

Describes the result of the action in human-readable form

nick_name

string

Short casual name used to address the contact (only available for 'personal' and 'user' accounts)

lang

string

Preferred communication language (only available for 'personal' and 'user' accounts)

invoiced_items

array

Line items to charge on checkout

created_at

string

Date/time of creation (in ISO format)

description

string

Free-form text description for the transaction

amount

string

Amount being transfered

is_debit

string

True if the transaction is indentified as a debit in the API context

orig_account

string

Source account from which funds are withdrawn

orig_profile

object

Billing profile from which funds are withdrawn

slug

string

Unique identifier shown in the URL bar

printable_name

string

Name that can be safely used for display in HTML pages

picture

string

URL location of the profile picture

type

string

One of 'organization', 'personal' or 'user'

credentials

string

True if the account has valid login credentials

created_at

string

Date/time of creation (in ISO format)

orig_amount

integer

Amount withdrawn from source in orig_unit

orig_unit

string

Three-letter ISO 4217 code for source currency unit (ex: usd)

dest_account

string

Target account to which funds are deposited

dest_profile

object

Billing profile to which funds are deposited

slug

string

Unique identifier shown in the URL bar

printable_name

string

Name that can be safely used for display in HTML pages

picture

string

URL location of the profile picture

type

string

One of 'organization', 'personal' or 'user'

credentials

string

True if the account has valid login credentials

created_at

string

Date/time of creation (in ISO format)

dest_amount

integer

Amount deposited into target in dest_unit

dest_unit

string

Three-letter ISO 4217 code for target currency unit (ex: usd)

Examples

{
  "event": "order_executed",
  "broker": {
    "slug": "djaoapp",
    "printable_name": "DjaoApp",
    "full_name": "DjaoApp inc.",
    "nick_name": "DjaoApp",
    "picture": null,
    "type": "organization",
    "credentials": false,
    "created_at": "2024-01-01T00:00:00Z",
    "email": "djaoapp@localhost.localdomain",
    "phone": "415-555-5555",
    "street_address": "1 SaaS Road",
    "locality": "San Francisco",
    "region": "California",
    "postal_code": "94133",
    "country": "US",
    "default_timezone": "America/Los_Angeles",
    "is_provider": true,
    "is_bulk_buyer": false,
    "lang": "en",
    "extra": null
  },
  "back_url": "http://localhost:8020",
  "profile": {
    "slug": "xia",
    "printable_name": "Xia",
    "full_name": "Xia Lee",
    "nick_name": "Xia",
    "picture": null,
    "type": "personal",
    "credentials": true,
    "created_at": "2024-01-01T00:00:00Z",
    "email": "xia@localhost.localdomain",
    "phone": "415-555-5556",
    "street_address": "1 SaaS Road",
    "locality": "San Francisco",
    "region": "California",
    "postal_code": "94133",
    "country": "US",
    "default_timezone": "America/Los_Angeles",
    "is_provider": false,
    "is_bulk_buyer": false,
    "lang": "en",
    "extra": null
  },
  "originated_by": {
    "slug": "xia",
    "username": "xia",
    "printable_name": "Xia",
    "full_name": "Xia Lee",
    "nick_name": "Xia",
    "picture": null,
    "type": "personal",
    "credentials": true,
    "created_at": "2024-01-01T00:00:00Z",
    "last_login": "2024-01-01T00:00:00Z",
    "email": "xia@localhost.localdomain",
    "phone": "415-555-5556",
    "lang": "en",
    "extra": null
  },
  "invoiced_items": [
    {
      "created_at": "2024-01-01T00:00:00Z",
      "description": "subscription to premium",
      "amount": 11900,
      "is_debit": false,
      "orig_account": "Receivable",
      "orig_profile": {
        "slug": "djaoapp",
        "printable_name": "DjaoApp",
        "picture": null,
        "type": "organization",
        "credentials": false
      },
      "orig_amount": 11900,
      "orig_unit": "usd",
      "dest_account": "Payable",
      "dest_profile": {
        "slug": "xia",
        "printable_name": "Xia",
        "picture": null,
        "type": "personal",
        "credentials": true
      },
      "dest_amount": 11900,
      "dest_unit": "usd"
    }
  ],
  "provider": {
    "slug": "djaoapp",
    "printable_name": "DjaoApp",
    "full_name": "DjaoApp inc.",
    "nick_name": "DjaoApp",
    "picture": null,
    "type": "organization",
    "credentials": false,
    "created_at": "2024-01-01T00:00:00Z",
    "email": "djaoapp@localhost.localdomain",
    "phone": "415-555-5555",
    "street_address": "1 SaaS Road",
    "locality": "San Francisco",
    "region": "California",
    "postal_code": "94133",
    "country": "US",
    "default_timezone": "America/Los_Angeles",
    "is_provider": true,
    "is_bulk_buyer": false,
    "lang": "en",
    "extra": null
  }
}

Weekly sales report

This notification contains the weekly sales results.

Definition

event

"period_sales_report_created"

broker

object

Site on which the product is hosted

slug

string

Unique identifier shown in the URL bar

printable_name

string

Name that can be safely used for display in HTML pages

picture

string

URL location of the profile picture

type

string

One of 'organization', 'personal' or 'user'

credentials

string

True if the account has valid login credentials

created_at

string

Date/time of creation (in ISO format)

full_name

string

Full name

string

E-mail address

phone

string

Phone number

street_address

string

Street address

locality

string

City/Town

region

string

State/Province/County

postal_code

string

Zip/Postal code

country

string

Country as 2-letter code (ISO 3166-1)

default_timezone

string

Timezone to use when reporting metrics

is_provider

boolean

The profile can fulfill the provider side of a subscription.

is_bulk_buyer

boolean

Enable GroupBuy

extra

string

Extra meta data (can be stringify JSON)

detail

string

Describes the result of the action in human-readable form

nick_name

string

Short casual name used to address the contact (only available for 'personal' and 'user' accounts)

lang

string

Preferred communication language (only available for 'personal' and 'user' accounts)

back_url

string

Link back to the site

profile

object

profile the notification relates to

slug

string

Unique identifier shown in the URL bar

printable_name

string

Name that can be safely used for display in HTML pages

picture

string

URL location of the profile picture

type

string

One of 'organization', 'personal' or 'user'

credentials

string

True if the account has valid login credentials

created_at

string

Date/time of creation (in ISO format)

full_name

string

Full name

string

E-mail address

phone

string

Phone number

street_address

string

Street address

locality

string

City/Town

region

string

State/Province/County

postal_code

string

Zip/Postal code

country

string

Country as 2-letter code (ISO 3166-1)

default_timezone

string

Timezone to use when reporting metrics

is_provider

boolean

The profile can fulfill the provider side of a subscription.

is_bulk_buyer

boolean

Enable GroupBuy

extra

string

Extra meta data (can be stringify JSON)

detail

string

Describes the result of the action in human-readable form

nick_name

string

Short casual name used to address the contact (only available for 'personal' and 'user' accounts)

lang

string

Preferred communication language (only available for 'personal' and 'user' accounts)

scale

number

The scale of the number reported in the tables (ex: 1000 when numbers are reported in thousands of dollars)

unit

string

Three-letter ISO 4217 code for currency unit (ex: usd)

title

string

Title for the table

results

array

Data series

slug

string

Unique key in the table for the data series

title

string

Title of data serie that can be safely used for display in HTML pages

extra

string

Extra meta data (can be stringify JSON)

values

array

List of (datetime, integer) couples that represents the data serie

selector

string

Filter on transaction accounts

Examples

{
  "event": "period_sales_report_created",
  "broker": {
    "slug": "djaoapp",
    "printable_name": "DjaoApp",
    "full_name": "DjaoApp inc.",
    "nick_name": "DjaoApp",
    "picture": null,
    "type": "organization",
    "credentials": false,
    "created_at": "2024-01-01T00:00:00Z",
    "email": "djaoapp@localhost.localdomain",
    "phone": "415-555-5555",
    "street_address": "1 SaaS Road",
    "locality": "San Francisco",
    "region": "California",
    "postal_code": "94133",
    "country": "US",
    "default_timezone": "America/Los_Angeles",
    "is_provider": true,
    "is_bulk_buyer": false,
    "lang": "en",
    "extra": null
  },
  "back_url": "http://localhost:8020",
  "profile": {
    "slug": "xia",
    "printable_name": "Xia",
    "full_name": "Xia Lee",
    "nick_name": "Xia",
    "picture": null,
    "type": "personal",
    "credentials": true,
    "created_at": "2024-01-01T00:00:00Z",
    "email": "xia@localhost.localdomain",
    "phone": "415-555-5556",
    "street_address": "1 SaaS Road",
    "locality": "San Francisco",
    "region": "California",
    "postal_code": "94133",
    "country": "US",
    "default_timezone": "America/Los_Angeles",
    "is_provider": false,
    "is_bulk_buyer": false,
    "lang": "en",
    "extra": null
  },
  "scale": 1,
  "unit": "usd",
  "title": "2024-01-07T00:00:00Z",
  "results": []
}

Error with processor setup

The processor returned an error when a user attempted to pay for a cart.

Definition

event

"processor_setup_error"

broker

object

Site on which the product is hosted

slug

string

Unique identifier shown in the URL bar

printable_name

string

Name that can be safely used for display in HTML pages

picture

string

URL location of the profile picture

type

string

One of 'organization', 'personal' or 'user'

credentials

string

True if the account has valid login credentials

created_at

string

Date/time of creation (in ISO format)

full_name

string

Full name

string

E-mail address

phone

string

Phone number

street_address

string

Street address

locality

string

City/Town

region

string

State/Province/County

postal_code

string

Zip/Postal code

country

string

Country as 2-letter code (ISO 3166-1)

default_timezone

string

Timezone to use when reporting metrics

is_provider

boolean

The profile can fulfill the provider side of a subscription.

is_bulk_buyer

boolean

Enable GroupBuy

extra

string

Extra meta data (can be stringify JSON)

detail

string

Describes the result of the action in human-readable form

nick_name

string

Short casual name used to address the contact (only available for 'personal' and 'user' accounts)

lang

string

Preferred communication language (only available for 'personal' and 'user' accounts)

back_url

string

Link back to the site

profile

object

profile the notification relates to

slug

string

Unique identifier shown in the URL bar

printable_name

string

Name that can be safely used for display in HTML pages

picture

string

URL location of the profile picture

type

string

One of 'organization', 'personal' or 'user'

credentials

string

True if the account has valid login credentials

created_at

string

Date/time of creation (in ISO format)

full_name

string

Full name

string

E-mail address

phone

string

Phone number

street_address

string

Street address

locality

string

City/Town

region

string

State/Province/County

postal_code

string

Zip/Postal code

country

string

Country as 2-letter code (ISO 3166-1)

default_timezone

string

Timezone to use when reporting metrics

is_provider

boolean

The profile can fulfill the provider side of a subscription.

is_bulk_buyer

boolean

Enable GroupBuy

extra

string

Extra meta data (can be stringify JSON)

detail

string

Describes the result of the action in human-readable form

nick_name

string

Short casual name used to address the contact (only available for 'personal' and 'user' accounts)

lang

string

Preferred communication language (only available for 'personal' and 'user' accounts)

originated_by

object

the user at the origin of the notification

slug

string

Unique identifier that can safely be used in place of username

username

string

Unique identifier for the user, typically used in URLs

printable_name

string

Name that can be safely used for display in HTML pages

picture

string

URL location of the profile picture

string

Primary e-mail address to contact user

phone

string

Primary phone number to contact user

full_name

string

Full name (effectively first name followed by last name)

nick_name

string

Short casual name used to address the user

lang

string

Preferred communication language

credentials

string

True if the user has valid login credentials

otp_enabled

string

True if the user has valid login credentials

created_at

string

Date at which the user account was created

last_login

string

Date at which the user last logged in

email_code

integer

Email verification code

phone_code

integer

Phone verification code

provider

object

provider when different from broker

slug

string

Unique identifier shown in the URL bar

printable_name

string

Name that can be safely used for display in HTML pages

picture

string

URL location of the profile picture

type

string

One of 'organization', 'personal' or 'user'

credentials

string

True if the account has valid login credentials

created_at

string

Date/time of creation (in ISO format)

full_name

string

Full name

string

E-mail address

phone

string

Phone number

street_address

string

Street address

locality

string

City/Town

region

string

State/Province/County

postal_code

string

Zip/Postal code

country

string

Country as 2-letter code (ISO 3166-1)

default_timezone

string

Timezone to use when reporting metrics

is_provider

boolean

The profile can fulfill the provider side of a subscription.

is_bulk_buyer

boolean

Enable GroupBuy

extra

string

Extra meta data (can be stringify JSON)

detail

string

Describes the result of the action in human-readable form

nick_name

string

Short casual name used to address the contact (only available for 'personal' and 'user' accounts)

lang

string

Preferred communication language (only available for 'personal' and 'user' accounts)

detail

string

Describes the result of the action in human-readable form

Examples

{
  "event": "processor_setup_error",
  "broker": {
    "slug": "djaoapp",
    "printable_name": "DjaoApp",
    "full_name": "DjaoApp inc.",
    "nick_name": "DjaoApp",
    "picture": null,
    "type": "organization",
    "credentials": false,
    "created_at": "2024-01-01T00:00:00Z",
    "email": "djaoapp@localhost.localdomain",
    "phone": "415-555-5555",
    "street_address": "1 SaaS Road",
    "locality": "San Francisco",
    "region": "California",
    "postal_code": "94133",
    "country": "US",
    "default_timezone": "America/Los_Angeles",
    "is_provider": true,
    "is_bulk_buyer": false,
    "lang": "en",
    "extra": null
  },
  "back_url": "http://localhost:8020",
  "profile": {
    "slug": "xia",
    "printable_name": "Xia",
    "full_name": "Xia Lee",
    "nick_name": "Xia",
    "picture": null,
    "type": "personal",
    "credentials": true,
    "created_at": "2024-01-01T00:00:00Z",
    "email": "xia@localhost.localdomain",
    "phone": "415-555-5556",
    "street_address": "1 SaaS Road",
    "locality": "San Francisco",
    "region": "California",
    "postal_code": "94133",
    "country": "US",
    "default_timezone": "America/Los_Angeles",
    "is_provider": false,
    "is_bulk_buyer": false,
    "lang": "en",
    "extra": null
  },
  "originated_by": {
    "slug": "xia",
    "username": "xia",
    "printable_name": "Xia",
    "full_name": "Xia Lee",
    "nick_name": "Xia",
    "picture": null,
    "type": "personal",
    "credentials": true,
    "created_at": "2024-01-01T00:00:00Z",
    "last_login": "2024-01-01T00:00:00Z",
    "email": "xia@localhost.localdomain",
    "phone": "415-555-5556",
    "lang": "en",
    "extra": null
  },
  "detail": "There is no payment processor account connected.",
  "provider": {
    "slug": "djaoapp",
    "printable_name": "DjaoApp",
    "full_name": "DjaoApp inc.",
    "nick_name": "DjaoApp",
    "picture": null,
    "type": "organization",
    "credentials": false,
    "created_at": "2024-01-01T00:00:00Z",
    "email": "djaoapp@localhost.localdomain",
    "phone": "415-555-5555",
    "street_address": "1 SaaS Road",
    "locality": "San Francisco",
    "region": "California",
    "postal_code": "94133",
    "country": "US",
    "default_timezone": "America/Los_Angeles",
    "is_provider": true,
    "is_bulk_buyer": false,
    "lang": "en",
    "extra": null
  }
}

Profile updated

This notification is sent when a profile is updated.

Definition

event

"profile_updated"

broker

object

Site on which the product is hosted

slug

string

Unique identifier shown in the URL bar

printable_name

string

Name that can be safely used for display in HTML pages

picture

string

URL location of the profile picture

type

string

One of 'organization', 'personal' or 'user'

credentials

string

True if the account has valid login credentials

created_at

string

Date/time of creation (in ISO format)

full_name

string

Full name

string

E-mail address

phone

string

Phone number

street_address

string

Street address

locality

string

City/Town

region

string

State/Province/County

postal_code

string

Zip/Postal code

country

string

Country as 2-letter code (ISO 3166-1)

default_timezone

string

Timezone to use when reporting metrics

is_provider

boolean

The profile can fulfill the provider side of a subscription.

is_bulk_buyer

boolean

Enable GroupBuy

extra

string

Extra meta data (can be stringify JSON)

detail

string

Describes the result of the action in human-readable form

nick_name

string

Short casual name used to address the contact (only available for 'personal' and 'user' accounts)

lang

string

Preferred communication language (only available for 'personal' and 'user' accounts)

back_url

string

Link back to the site

profile

object

profile the notification relates to

slug

string

Unique identifier shown in the URL bar

printable_name

string

Name that can be safely used for display in HTML pages

picture

string

URL location of the profile picture

type

string

One of 'organization', 'personal' or 'user'

credentials

string

True if the account has valid login credentials

created_at

string

Date/time of creation (in ISO format)

full_name

string

Full name

string

E-mail address

phone

string

Phone number

street_address

string

Street address

locality

string

City/Town

region

string

State/Province/County

postal_code

string

Zip/Postal code

country

string

Country as 2-letter code (ISO 3166-1)

default_timezone

string

Timezone to use when reporting metrics

is_provider

boolean

The profile can fulfill the provider side of a subscription.

is_bulk_buyer

boolean

Enable GroupBuy

extra

string

Extra meta data (can be stringify JSON)

detail

string

Describes the result of the action in human-readable form

nick_name

string

Short casual name used to address the contact (only available for 'personal' and 'user' accounts)

lang

string

Preferred communication language (only available for 'personal' and 'user' accounts)

originated_by

object

the user at the origin of the notification

slug

string

Unique identifier that can safely be used in place of username

username

string

Unique identifier for the user, typically used in URLs

printable_name

string

Name that can be safely used for display in HTML pages

picture

string

URL location of the profile picture

string

Primary e-mail address to contact user

phone

string

Primary phone number to contact user

full_name

string

Full name (effectively first name followed by last name)

nick_name

string

Short casual name used to address the user

lang

string

Preferred communication language

credentials

string

True if the user has valid login credentials

otp_enabled

string

True if the user has valid login credentials

created_at

string

Date at which the user account was created

last_login

string

Date at which the user last logged in

email_code

integer

Email verification code

phone_code

integer

Phone verification code

changes

object

changes to the profile

Examples

{
  "event": "profile_updated",
  "broker": {
    "slug": "djaoapp",
    "printable_name": "DjaoApp",
    "full_name": "DjaoApp inc.",
    "nick_name": "DjaoApp",
    "picture": null,
    "type": "organization",
    "credentials": false,
    "created_at": "2024-01-01T00:00:00Z",
    "email": "djaoapp@localhost.localdomain",
    "phone": "415-555-5555",
    "street_address": "1 SaaS Road",
    "locality": "San Francisco",
    "region": "California",
    "postal_code": "94133",
    "country": "US",
    "default_timezone": "America/Los_Angeles",
    "is_provider": true,
    "is_bulk_buyer": false,
    "lang": "en",
    "extra": null
  },
  "back_url": "http://localhost:8020",
  "profile": {
    "slug": "xia",
    "printable_name": "Xia",
    "full_name": "Xia Lee",
    "nick_name": "Xia",
    "picture": null,
    "type": "personal",
    "credentials": true,
    "created_at": "2024-01-01T00:00:00Z",
    "email": "xia@localhost.localdomain",
    "phone": "415-555-5556",
    "street_address": "1 SaaS Road",
    "locality": "San Francisco",
    "region": "California",
    "postal_code": "94133",
    "country": "US",
    "default_timezone": "America/Los_Angeles",
    "is_provider": false,
    "is_bulk_buyer": false,
    "lang": "en",
    "extra": null
  },
  "originated_by": {
    "slug": "xia",
    "username": "xia",
    "printable_name": "Xia",
    "full_name": "Xia Lee",
    "nick_name": "Xia",
    "picture": null,
    "type": "personal",
    "credentials": true,
    "created_at": "2024-01-01T00:00:00Z",
    "last_login": "2024-01-01T00:00:00Z",
    "email": "xia@localhost.localdomain",
    "phone": "415-555-5556",
    "lang": "en",
    "extra": null
  },
  "changes": {
    "full_name": {
      "pre": "Xia Lee",
      "post": "Xia Wang"
    }
  }
}

Quota reached

This notification is sent when a profile has passed the free quota allocated per billing period for use charges.

Definition

event

"quota_reached"

broker

object

Site on which the product is hosted

slug

string

Unique identifier shown in the URL bar

printable_name

string

Name that can be safely used for display in HTML pages

picture

string

URL location of the profile picture

type

string

One of 'organization', 'personal' or 'user'

credentials

string

True if the account has valid login credentials

created_at

string

Date/time of creation (in ISO format)

full_name

string

Full name

string

E-mail address

phone

string

Phone number

street_address

string

Street address

locality

string

City/Town

region

string

State/Province/County

postal_code

string

Zip/Postal code

country

string

Country as 2-letter code (ISO 3166-1)

default_timezone

string

Timezone to use when reporting metrics

is_provider

boolean

The profile can fulfill the provider side of a subscription.

is_bulk_buyer

boolean

Enable GroupBuy

extra

string

Extra meta data (can be stringify JSON)

detail

string

Describes the result of the action in human-readable form

nick_name

string

Short casual name used to address the contact (only available for 'personal' and 'user' accounts)

lang

string

Preferred communication language (only available for 'personal' and 'user' accounts)

back_url

string

Link back to the site

profile

object

profile the notification relates to

slug

string

Unique identifier shown in the URL bar

printable_name

string

Name that can be safely used for display in HTML pages

picture

string

URL location of the profile picture

type

string

One of 'organization', 'personal' or 'user'

credentials

string

True if the account has valid login credentials

created_at

string

Date/time of creation (in ISO format)

full_name

string

Full name

string

E-mail address

phone

string

Phone number

street_address

string

Street address

locality

string

City/Town

region

string

State/Province/County

postal_code

string

Zip/Postal code

country

string

Country as 2-letter code (ISO 3166-1)

default_timezone

string

Timezone to use when reporting metrics

is_provider

boolean

The profile can fulfill the provider side of a subscription.

is_bulk_buyer

boolean

Enable GroupBuy

extra

string

Extra meta data (can be stringify JSON)

detail

string

Describes the result of the action in human-readable form

nick_name

string

Short casual name used to address the contact (only available for 'personal' and 'user' accounts)

lang

string

Preferred communication language (only available for 'personal' and 'user' accounts)

plan

object

plan the subscription relates to

slug

string

Unique identifier shown in the URL bar

title

string

Title for the plan

provider

object

provider when different from broker

slug

string

Unique identifier shown in the URL bar

printable_name

string

Name that can be safely used for display in HTML pages

picture

string

URL location of the profile picture

type

string

One of 'organization', 'personal' or 'user'

credentials

string

True if the account has valid login credentials

created_at

string

Date/time of creation (in ISO format)

full_name

string

Full name

string

E-mail address

phone

string

Phone number

street_address

string

Street address

locality

string

City/Town

region

string

State/Province/County

postal_code

string

Zip/Postal code

country

string

Country as 2-letter code (ISO 3166-1)

default_timezone

string

Timezone to use when reporting metrics

is_provider

boolean

The profile can fulfill the provider side of a subscription.

is_bulk_buyer

boolean

Enable GroupBuy

extra

string

Extra meta data (can be stringify JSON)

detail

string

Describes the result of the action in human-readable form

nick_name

string

Short casual name used to address the contact (only available for 'personal' and 'user' accounts)

lang

string

Preferred communication language (only available for 'personal' and 'user' accounts)

use_charge

object

use charge the notification relates to

slug

string

Unique identifier shown in the URL bar

title

string

Short description of the use charge

description

string

Long description of the use charge

created_at

string

Date/time of creation (in ISO format)

use_amount

integer

Amount per unit defined by the provider of the use charge in plan currency unit (ex: $0.01/request)

quota

integer

Usage included in the plan (in units defined by the provider)

maximum_limit

integer

Maximum spend limit per period above which the subscriber is notified (in currency unit)

extra

string

Extra meta data (can be stringify JSON)

usage

integer

current usage in billing period

Examples

{
  "event": "quota_reached",
  "broker": {
    "slug": "djaoapp",
    "printable_name": "DjaoApp",
    "full_name": "DjaoApp inc.",
    "nick_name": "DjaoApp",
    "picture": null,
    "type": "organization",
    "credentials": false,
    "created_at": "2024-01-01T00:00:00Z",
    "email": "djaoapp@localhost.localdomain",
    "phone": "415-555-5555",
    "street_address": "1 SaaS Road",
    "locality": "San Francisco",
    "region": "California",
    "postal_code": "94133",
    "country": "US",
    "default_timezone": "America/Los_Angeles",
    "is_provider": true,
    "is_bulk_buyer": false,
    "lang": "en",
    "extra": null
  },
  "back_url": "http://localhost:8020",
  "profile": {
    "slug": "xia",
    "printable_name": "Xia",
    "full_name": "Xia Lee",
    "nick_name": "Xia",
    "picture": null,
    "type": "personal",
    "credentials": true,
    "created_at": "2024-01-01T00:00:00Z",
    "email": "xia@localhost.localdomain",
    "phone": "415-555-5556",
    "street_address": "1 SaaS Road",
    "locality": "San Francisco",
    "region": "California",
    "postal_code": "94133",
    "country": "US",
    "default_timezone": "America/Los_Angeles",
    "is_provider": false,
    "is_bulk_buyer": false,
    "lang": "en",
    "extra": null
  },
  "plan": {
    "slug": "premium",
    "title": "Premium"
  },
  "use_charge": {
    "slug": "http-requests",
    "title": "Number of HTTP requests",
    "description": "",
    "created_at": "2024-01-01T00:00:00Z",
    "use_amount": 1,
    "quota": 100000,
    "maximum_limit": 1000000,
    "extra": null
  },
  "usage": 100010
}

Renewal failed

This notification is sent when attempting to charge the credit card on file for renewal failed.

Definition

event

"renewal_charge_failed"

broker

object

Site on which the product is hosted

slug

string

Unique identifier shown in the URL bar

printable_name

string

Name that can be safely used for display in HTML pages

picture

string

URL location of the profile picture

type

string

One of 'organization', 'personal' or 'user'

credentials

string

True if the account has valid login credentials

created_at

string

Date/time of creation (in ISO format)

full_name

string

Full name

string

E-mail address

phone

string

Phone number

street_address

string

Street address

locality

string

City/Town

region

string

State/Province/County

postal_code

string

Zip/Postal code

country

string

Country as 2-letter code (ISO 3166-1)

default_timezone

string

Timezone to use when reporting metrics

is_provider

boolean

The profile can fulfill the provider side of a subscription.

is_bulk_buyer

boolean

Enable GroupBuy

extra

string

Extra meta data (can be stringify JSON)

detail

string

Describes the result of the action in human-readable form

nick_name

string

Short casual name used to address the contact (only available for 'personal' and 'user' accounts)

lang

string

Preferred communication language (only available for 'personal' and 'user' accounts)

back_url

string

Link back to the site

profile

object

profile the notification relates to

slug

string

Unique identifier shown in the URL bar

printable_name

string

Name that can be safely used for display in HTML pages

picture

string

URL location of the profile picture

type

string

One of 'organization', 'personal' or 'user'

credentials

string

True if the account has valid login credentials

created_at

string

Date/time of creation (in ISO format)

full_name

string

Full name

string

E-mail address

phone

string

Phone number

street_address

string

Street address

locality

string

City/Town

region

string

State/Province/County

postal_code

string

Zip/Postal code

country

string

Country as 2-letter code (ISO 3166-1)

default_timezone

string

Timezone to use when reporting metrics

is_provider

boolean

The profile can fulfill the provider side of a subscription.

is_bulk_buyer

boolean

Enable GroupBuy

extra

string

Extra meta data (can be stringify JSON)

detail

string

Describes the result of the action in human-readable form

nick_name

string

Short casual name used to address the contact (only available for 'personal' and 'user' accounts)

lang

string

Preferred communication language (only available for 'personal' and 'user' accounts)

provider

object

provider when different from broker

slug

string

Unique identifier shown in the URL bar

printable_name

string

Name that can be safely used for display in HTML pages

picture

string

URL location of the profile picture

type

string

One of 'organization', 'personal' or 'user'

credentials

string

True if the account has valid login credentials

created_at

string

Date/time of creation (in ISO format)

full_name

string

Full name

string

E-mail address

phone

string

Phone number

street_address

string

Street address

locality

string

City/Town

region

string

State/Province/County

postal_code

string

Zip/Postal code

country

string

Country as 2-letter code (ISO 3166-1)

default_timezone

string

Timezone to use when reporting metrics

is_provider

boolean

The profile can fulfill the provider side of a subscription.

is_bulk_buyer

boolean

Enable GroupBuy

extra

string

Extra meta data (can be stringify JSON)

detail

string

Describes the result of the action in human-readable form

nick_name

string

Short casual name used to address the contact (only available for 'personal' and 'user' accounts)

lang

string

Preferred communication language (only available for 'personal' and 'user' accounts)

invoiced_items

array

Line items to charge for renewal

created_at

string

Date/time of creation (in ISO format)

description

string

Free-form text description for the transaction

amount

string

Amount being transfered

is_debit

string

True if the transaction is indentified as a debit in the API context

orig_account

string

Source account from which funds are withdrawn

orig_profile

object

Billing profile from which funds are withdrawn

slug

string

Unique identifier shown in the URL bar

printable_name

string

Name that can be safely used for display in HTML pages

picture

string

URL location of the profile picture

type

string

One of 'organization', 'personal' or 'user'

credentials

string

True if the account has valid login credentials

created_at

string

Date/time of creation (in ISO format)

orig_amount

integer

Amount withdrawn from source in orig_unit

orig_unit

string

Three-letter ISO 4217 code for source currency unit (ex: usd)

dest_account

string

Target account to which funds are deposited

dest_profile

object

Billing profile to which funds are deposited

slug

string

Unique identifier shown in the URL bar

printable_name

string

Name that can be safely used for display in HTML pages

picture

string

URL location of the profile picture

type

string

One of 'organization', 'personal' or 'user'

credentials

string

True if the account has valid login credentials

created_at

string

Date/time of creation (in ISO format)

dest_amount

integer

Amount deposited into target in dest_unit

dest_unit

string

Three-letter ISO 4217 code for target currency unit (ex: usd)

charge_total

object

Total amount for the charge

amount

integer

amount in unit

unit

string

Three-letter ISO 4217 code for currency unit (ex: usd)

nb_renewal_attempts

integer

number renewal attempts

max_renewal_attempts

integer

maximimum number of renewal attempts

final_notice

boolean

true if this is the final notice before subscription is canceled

Examples

{
  "event": "renewal_charge_failed",
  "broker": {
    "slug": "djaoapp",
    "printable_name": "DjaoApp",
    "full_name": "DjaoApp inc.",
    "nick_name": "DjaoApp",
    "picture": null,
    "type": "organization",
    "credentials": false,
    "created_at": "2024-01-01T00:00:00Z",
    "email": "djaoapp@localhost.localdomain",
    "phone": "415-555-5555",
    "street_address": "1 SaaS Road",
    "locality": "San Francisco",
    "region": "California",
    "postal_code": "94133",
    "country": "US",
    "default_timezone": "America/Los_Angeles",
    "is_provider": true,
    "is_bulk_buyer": false,
    "lang": "en",
    "extra": null
  },
  "back_url": "http://localhost:8020",
  "profile": {
    "slug": "xia",
    "printable_name": "Xia",
    "full_name": "Xia Lee",
    "nick_name": "Xia",
    "picture": null,
    "type": "personal",
    "credentials": true,
    "created_at": "2024-01-01T00:00:00Z",
    "email": "xia@localhost.localdomain",
    "phone": "415-555-5556",
    "street_address": "1 SaaS Road",
    "locality": "San Francisco",
    "region": "California",
    "postal_code": "94133",
    "country": "US",
    "default_timezone": "America/Los_Angeles",
    "is_provider": false,
    "is_bulk_buyer": false,
    "lang": "en",
    "extra": null
  },
  "charge_total": {
    "amount": 11900,
    "unit": "usd"
  },
  "invoiced_items": [
    {
      "created_at": "2024-01-01T00:00:00Z",
      "description": "subscription to premium",
      "amount": 11900,
      "is_debit": false,
      "orig_account": "Receivable",
      "orig_profile": {
        "slug": "djaoapp",
        "printable_name": "DjaoApp",
        "picture": null,
        "type": "organization",
        "credentials": false
      },
      "orig_amount": 11900,
      "orig_unit": "usd",
      "dest_account": "Payable",
      "dest_profile": {
        "slug": "xia",
        "printable_name": "Xia",
        "picture": null,
        "type": "personal",
        "credentials": true
      },
      "dest_amount": 11900,
      "dest_unit": "usd"
    }
  ],
  "nb_renewal_attempts": 1,
  "max_renewal_attempts": 3,
  "final_notice": false,
  "provider": {
    "slug": "djaoapp",
    "printable_name": "DjaoApp",
    "full_name": "DjaoApp inc.",
    "nick_name": "DjaoApp",
    "picture": null,
    "type": "organization",
    "credentials": false,
    "created_at": "2024-01-01T00:00:00Z",
    "email": "djaoapp@localhost.localdomain",
    "phone": "415-555-5555",
    "street_address": "1 SaaS Road",
    "locality": "San Francisco",
    "region": "California",
    "postal_code": "94133",
    "country": "US",
    "default_timezone": "America/Los_Angeles",
    "is_provider": true,
    "is_bulk_buyer": false,
    "lang": "en",
    "extra": null
  }
}

Role grant accepted

This notification is sent when a user has accepted a role that was granted on a profile.

Definition

event

"role_grant_accepted"

broker

object

Site on which the product is hosted

slug

string

Unique identifier shown in the URL bar

printable_name

string

Name that can be safely used for display in HTML pages

picture

string

URL location of the profile picture

type

string

One of 'organization', 'personal' or 'user'

credentials

string

True if the account has valid login credentials

created_at

string

Date/time of creation (in ISO format)

full_name

string

Full name

string

E-mail address

phone

string

Phone number

street_address

string

Street address

locality

string

City/Town

region

string

State/Province/County

postal_code

string

Zip/Postal code

country

string

Country as 2-letter code (ISO 3166-1)

default_timezone

string

Timezone to use when reporting metrics

is_provider

boolean

The profile can fulfill the provider side of a subscription.

is_bulk_buyer

boolean

Enable GroupBuy

extra

string

Extra meta data (can be stringify JSON)

detail

string

Describes the result of the action in human-readable form

nick_name

string

Short casual name used to address the contact (only available for 'personal' and 'user' accounts)

lang

string

Preferred communication language (only available for 'personal' and 'user' accounts)

back_url

string

Link back to the site

profile

object

profile the notification relates to

slug

string

Unique identifier shown in the URL bar

printable_name

string

Name that can be safely used for display in HTML pages

picture

string

URL location of the profile picture

type

string

One of 'organization', 'personal' or 'user'

credentials

string

True if the account has valid login credentials

created_at

string

Date/time of creation (in ISO format)

full_name

string

Full name

string

E-mail address

phone

string

Phone number

street_address

string

Street address

locality

string

City/Town

region

string

State/Province/County

postal_code

string

Zip/Postal code

country

string

Country as 2-letter code (ISO 3166-1)

default_timezone

string

Timezone to use when reporting metrics

is_provider

boolean

The profile can fulfill the provider side of a subscription.

is_bulk_buyer

boolean

Enable GroupBuy

extra

string

Extra meta data (can be stringify JSON)

detail

string

Describes the result of the action in human-readable form

nick_name

string

Short casual name used to address the contact (only available for 'personal' and 'user' accounts)

lang

string

Preferred communication language (only available for 'personal' and 'user' accounts)

originated_by

object

the user at the origin of the notification

slug

string

Unique identifier that can safely be used in place of username

username

string

Unique identifier for the user, typically used in URLs

printable_name

string

Name that can be safely used for display in HTML pages

picture

string

URL location of the profile picture

string

Primary e-mail address to contact user

phone

string

Primary phone number to contact user

full_name

string

Full name (effectively first name followed by last name)

nick_name

string

Short casual name used to address the user

lang

string

Preferred communication language

credentials

string

True if the user has valid login credentials

otp_enabled

string

True if the user has valid login credentials

created_at

string

Date at which the user account was created

last_login

string

Date at which the user last logged in

email_code

integer

Email verification code

phone_code

integer

Phone verification code

user

object

user the notification applies to

slug

string

Unique identifier that can safely be used in place of username

username

string

Unique identifier for the user, typically used in URLs

printable_name

string

Name that can be safely used for display in HTML pages

picture

string

URL location of the profile picture

string

Primary e-mail address to contact user

phone

string

Primary phone number to contact user

full_name

string

Full name (effectively first name followed by last name)

nick_name

string

Short casual name used to address the user

lang

string

Preferred communication language

credentials

string

True if the user has valid login credentials

otp_enabled

string

True if the user has valid login credentials

created_at

string

Date at which the user account was created

last_login

string

Date at which the user last logged in

email_code

integer

Email verification code

phone_code

integer

Phone verification code

detail

string

optional message at the attention of the user

role_description

object

description of the role the notification is about

created_at

string

Date/time of creation (in ISO format)

slug

string

Unique identifier shown in the URL bar

title

string

Short description of the role. Grammatical rules to pluralize the title might be used in User Interfaces.

skip_optin_on_grant

boolean

Automatically grants the role without requiring a user to accept it.

implicit_create_on_none

boolean

Automatically adds the role when a user and profile share the same e-mail domain.

otp_required

boolean

Requires users with the role to sign-in using an OTP code as a multi-factor authentication.

is_global

boolean

True when the role type is available for all profiles

profile

object

Profile the role type belongs to

slug

string

Unique identifier shown in the URL bar

printable_name

string

Name that can be safely used for display in HTML pages

picture

string

URL location of the profile picture

type

string

One of 'organization', 'personal' or 'user'

credentials

string

True if the account has valid login credentials

created_at

string

Date/time of creation (in ISO format)

extra

string

Extra meta data (can be stringify JSON)

editable

string

True if the request user is able to update the role description. Typically a profile manager for the organization (local role description) or the broker (global role descriptions).

Examples

{
  "event": "role_grant_accepted",
  "broker": {
    "slug": "djaoapp",
    "printable_name": "DjaoApp",
    "full_name": "DjaoApp inc.",
    "nick_name": "DjaoApp",
    "picture": null,
    "type": "organization",
    "credentials": false,
    "created_at": "2024-01-01T00:00:00Z",
    "email": "djaoapp@localhost.localdomain",
    "phone": "415-555-5555",
    "street_address": "1 SaaS Road",
    "locality": "San Francisco",
    "region": "California",
    "postal_code": "94133",
    "country": "US",
    "default_timezone": "America/Los_Angeles",
    "is_provider": true,
    "is_bulk_buyer": false,
    "lang": "en",
    "extra": null
  },
  "back_url": "http://localhost:8020",
  "profile": {
    "slug": "xia",
    "printable_name": "Xia",
    "full_name": "Xia Lee",
    "nick_name": "Xia",
    "picture": null,
    "type": "personal",
    "credentials": true,
    "created_at": "2024-01-01T00:00:00Z",
    "email": "xia@localhost.localdomain",
    "phone": "415-555-5556",
    "street_address": "1 SaaS Road",
    "locality": "San Francisco",
    "region": "California",
    "postal_code": "94133",
    "country": "US",
    "default_timezone": "America/Los_Angeles",
    "is_provider": false,
    "is_bulk_buyer": false,
    "lang": "en",
    "extra": null
  },
  "originated_by": {
    "slug": "xia",
    "username": "xia",
    "printable_name": "Xia",
    "full_name": "Xia Lee",
    "nick_name": "Xia",
    "picture": null,
    "type": "personal",
    "credentials": true,
    "created_at": "2024-01-01T00:00:00Z",
    "last_login": "2024-01-01T00:00:00Z",
    "email": "xia@localhost.localdomain",
    "phone": "415-555-5556",
    "lang": "en",
    "extra": null
  },
  "user": {
    "slug": "emilie",
    "username": "emilie",
    "printable_name": "Emilie",
    "full_name": "Emilie Jolie",
    "nick_name": "Emilie",
    "picture": null,
    "type": "user",
    "credentials": false,
    "created_at": "2024-01-01T00:00:00Z",
    "last_login": "",
    "email": "emilie@localhost.localdomain",
    "phone": "415-555-5557",
    "lang": "en",
    "extra": null
  },
  "role_description": {
    "slug": "manager",
    "title": "Managers"
  }
}

Role granted

This notification is sent when a user has been granted a role on a profile.

Definition

event

"role_grant_created"

broker

object

Site on which the product is hosted

slug

string

Unique identifier shown in the URL bar

printable_name

string

Name that can be safely used for display in HTML pages

picture

string

URL location of the profile picture

type

string

One of 'organization', 'personal' or 'user'

credentials

string

True if the account has valid login credentials

created_at

string

Date/time of creation (in ISO format)

full_name

string

Full name

string

E-mail address

phone

string

Phone number

street_address

string

Street address

locality

string

City/Town

region

string

State/Province/County

postal_code

string

Zip/Postal code

country

string

Country as 2-letter code (ISO 3166-1)

default_timezone

string

Timezone to use when reporting metrics

is_provider

boolean

The profile can fulfill the provider side of a subscription.

is_bulk_buyer

boolean

Enable GroupBuy

extra

string

Extra meta data (can be stringify JSON)

detail

string

Describes the result of the action in human-readable form

nick_name

string

Short casual name used to address the contact (only available for 'personal' and 'user' accounts)

lang

string

Preferred communication language (only available for 'personal' and 'user' accounts)

back_url

string

Link back to the site

profile

object

profile the notification relates to

slug

string

Unique identifier shown in the URL bar

printable_name

string

Name that can be safely used for display in HTML pages

picture

string

URL location of the profile picture

type

string

One of 'organization', 'personal' or 'user'

credentials

string

True if the account has valid login credentials

created_at

string

Date/time of creation (in ISO format)

full_name

string

Full name

string

E-mail address

phone

string

Phone number

street_address

string

Street address

locality

string

City/Town

region

string

State/Province/County

postal_code

string

Zip/Postal code

country

string

Country as 2-letter code (ISO 3166-1)

default_timezone

string

Timezone to use when reporting metrics

is_provider

boolean

The profile can fulfill the provider side of a subscription.

is_bulk_buyer

boolean

Enable GroupBuy

extra

string

Extra meta data (can be stringify JSON)

detail

string

Describes the result of the action in human-readable form

nick_name

string

Short casual name used to address the contact (only available for 'personal' and 'user' accounts)

lang

string

Preferred communication language (only available for 'personal' and 'user' accounts)

originated_by

object

the user at the origin of the notification

slug

string

Unique identifier that can safely be used in place of username

username

string

Unique identifier for the user, typically used in URLs

printable_name

string

Name that can be safely used for display in HTML pages

picture

string

URL location of the profile picture

string

Primary e-mail address to contact user

phone

string

Primary phone number to contact user

full_name

string

Full name (effectively first name followed by last name)

nick_name

string

Short casual name used to address the user

lang

string

Preferred communication language

credentials

string

True if the user has valid login credentials

otp_enabled

string

True if the user has valid login credentials

created_at

string

Date at which the user account was created

last_login

string

Date at which the user last logged in

email_code

integer

Email verification code

phone_code

integer

Phone verification code

user

object

user the notification applies to

slug

string

Unique identifier that can safely be used in place of username

username

string

Unique identifier for the user, typically used in URLs

printable_name

string

Name that can be safely used for display in HTML pages

picture

string

URL location of the profile picture

string

Primary e-mail address to contact user

phone

string

Primary phone number to contact user

full_name

string

Full name (effectively first name followed by last name)

nick_name

string

Short casual name used to address the user

lang

string

Preferred communication language

credentials

string

True if the user has valid login credentials

otp_enabled

string

True if the user has valid login credentials

created_at

string

Date at which the user account was created

last_login

string

Date at which the user last logged in

email_code

integer

Email verification code

phone_code

integer

Phone verification code

detail

string

optional message at the attention of the user

role_description

object

description of the role the notification is about

created_at

string

Date/time of creation (in ISO format)

slug

string

Unique identifier shown in the URL bar

title

string

Short description of the role. Grammatical rules to pluralize the title might be used in User Interfaces.

skip_optin_on_grant

boolean

Automatically grants the role without requiring a user to accept it.

implicit_create_on_none

boolean

Automatically adds the role when a user and profile share the same e-mail domain.

otp_required

boolean

Requires users with the role to sign-in using an OTP code as a multi-factor authentication.

is_global

boolean

True when the role type is available for all profiles

profile

object

Profile the role type belongs to

slug

string

Unique identifier shown in the URL bar

printable_name

string

Name that can be safely used for display in HTML pages

picture

string

URL location of the profile picture

type

string

One of 'organization', 'personal' or 'user'

credentials

string

True if the account has valid login credentials

created_at

string

Date/time of creation (in ISO format)

extra

string

Extra meta data (can be stringify JSON)

editable

string

True if the request user is able to update the role description. Typically a profile manager for the organization (local role description) or the broker (global role descriptions).

Examples

{
  "event": "role_grant_created",
  "broker": {
    "slug": "djaoapp",
    "printable_name": "DjaoApp",
    "full_name": "DjaoApp inc.",
    "nick_name": "DjaoApp",
    "picture": null,
    "type": "organization",
    "credentials": false,
    "created_at": "2024-01-01T00:00:00Z",
    "email": "djaoapp@localhost.localdomain",
    "phone": "415-555-5555",
    "street_address": "1 SaaS Road",
    "locality": "San Francisco",
    "region": "California",
    "postal_code": "94133",
    "country": "US",
    "default_timezone": "America/Los_Angeles",
    "is_provider": true,
    "is_bulk_buyer": false,
    "lang": "en",
    "extra": null
  },
  "back_url": "http://localhost:8020",
  "profile": {
    "slug": "xia",
    "printable_name": "Xia",
    "full_name": "Xia Lee",
    "nick_name": "Xia",
    "picture": null,
    "type": "personal",
    "credentials": true,
    "created_at": "2024-01-01T00:00:00Z",
    "email": "xia@localhost.localdomain",
    "phone": "415-555-5556",
    "street_address": "1 SaaS Road",
    "locality": "San Francisco",
    "region": "California",
    "postal_code": "94133",
    "country": "US",
    "default_timezone": "America/Los_Angeles",
    "is_provider": false,
    "is_bulk_buyer": false,
    "lang": "en",
    "extra": null
  },
  "originated_by": {
    "slug": "xia",
    "username": "xia",
    "printable_name": "Xia",
    "full_name": "Xia Lee",
    "nick_name": "Xia",
    "picture": null,
    "type": "personal",
    "credentials": true,
    "created_at": "2024-01-01T00:00:00Z",
    "last_login": "2024-01-01T00:00:00Z",
    "email": "xia@localhost.localdomain",
    "phone": "415-555-5556",
    "lang": "en",
    "extra": null
  },
  "user": {
    "slug": "emilie",
    "username": "emilie",
    "printable_name": "Emilie",
    "full_name": "Emilie Jolie",
    "nick_name": "Emilie",
    "picture": null,
    "type": "user",
    "credentials": false,
    "created_at": "2024-01-01T00:00:00Z",
    "last_login": "",
    "email": "emilie@localhost.localdomain",
    "phone": "415-555-5557",
    "lang": "en",
    "extra": null
  },
  "role_description": {
    "slug": "manager",
    "title": "Managers"
  }
}

Role requested

This notification is sent when a user has requested a role on a profile.

Definition

event

"role_request_created"

broker

object

Site on which the product is hosted

slug

string

Unique identifier shown in the URL bar

printable_name

string

Name that can be safely used for display in HTML pages

picture

string

URL location of the profile picture

type

string

One of 'organization', 'personal' or 'user'

credentials

string

True if the account has valid login credentials

created_at

string

Date/time of creation (in ISO format)

full_name

string

Full name

string

E-mail address

phone

string

Phone number

street_address

string

Street address

locality

string

City/Town

region

string

State/Province/County

postal_code

string

Zip/Postal code

country

string

Country as 2-letter code (ISO 3166-1)

default_timezone

string

Timezone to use when reporting metrics

is_provider

boolean

The profile can fulfill the provider side of a subscription.

is_bulk_buyer

boolean

Enable GroupBuy

extra

string

Extra meta data (can be stringify JSON)

detail

string

Describes the result of the action in human-readable form

nick_name

string

Short casual name used to address the contact (only available for 'personal' and 'user' accounts)

lang

string

Preferred communication language (only available for 'personal' and 'user' accounts)

back_url

string

Link back to the site

profile

object

profile the notification relates to

slug

string

Unique identifier shown in the URL bar

printable_name

string

Name that can be safely used for display in HTML pages

picture

string

URL location of the profile picture

type

string

One of 'organization', 'personal' or 'user'

credentials

string

True if the account has valid login credentials

created_at

string

Date/time of creation (in ISO format)

full_name

string

Full name

string

E-mail address

phone

string

Phone number

street_address

string

Street address

locality

string

City/Town

region

string

State/Province/County

postal_code

string

Zip/Postal code

country

string

Country as 2-letter code (ISO 3166-1)

default_timezone

string

Timezone to use when reporting metrics

is_provider

boolean

The profile can fulfill the provider side of a subscription.

is_bulk_buyer

boolean

Enable GroupBuy

extra

string

Extra meta data (can be stringify JSON)

detail

string

Describes the result of the action in human-readable form

nick_name

string

Short casual name used to address the contact (only available for 'personal' and 'user' accounts)

lang

string

Preferred communication language (only available for 'personal' and 'user' accounts)

originated_by

object

the user at the origin of the notification

slug

string

Unique identifier that can safely be used in place of username

username

string

Unique identifier for the user, typically used in URLs

printable_name

string

Name that can be safely used for display in HTML pages

picture

string

URL location of the profile picture

string

Primary e-mail address to contact user

phone

string

Primary phone number to contact user

full_name

string

Full name (effectively first name followed by last name)

nick_name

string

Short casual name used to address the user

lang

string

Preferred communication language

credentials

string

True if the user has valid login credentials

otp_enabled

string

True if the user has valid login credentials

created_at

string

Date at which the user account was created

last_login

string

Date at which the user last logged in

email_code

integer

Email verification code

phone_code

integer

Phone verification code

user

object

user the notification applies to

slug

string

Unique identifier that can safely be used in place of username

username

string

Unique identifier for the user, typically used in URLs

printable_name

string

Name that can be safely used for display in HTML pages

picture

string

URL location of the profile picture

string

Primary e-mail address to contact user

phone

string

Primary phone number to contact user

full_name

string

Full name (effectively first name followed by last name)

nick_name

string

Short casual name used to address the user

lang

string

Preferred communication language

credentials

string

True if the user has valid login credentials

otp_enabled

string

True if the user has valid login credentials

created_at

string

Date at which the user account was created

last_login

string

Date at which the user last logged in

email_code

integer

Email verification code

phone_code

integer

Phone verification code

detail

string

optional message at the attention of the user

Examples

{
  "event": "role_request_created",
  "broker": {
    "slug": "djaoapp",
    "printable_name": "DjaoApp",
    "full_name": "DjaoApp inc.",
    "nick_name": "DjaoApp",
    "picture": null,
    "type": "organization",
    "credentials": false,
    "created_at": "2024-01-01T00:00:00Z",
    "email": "djaoapp@localhost.localdomain",
    "phone": "415-555-5555",
    "street_address": "1 SaaS Road",
    "locality": "San Francisco",
    "region": "California",
    "postal_code": "94133",
    "country": "US",
    "default_timezone": "America/Los_Angeles",
    "is_provider": true,
    "is_bulk_buyer": false,
    "lang": "en",
    "extra": null
  },
  "back_url": "http://localhost:8020",
  "profile": {
    "slug": "xia",
    "printable_name": "Xia",
    "full_name": "Xia Lee",
    "nick_name": "Xia",
    "picture": null,
    "type": "personal",
    "credentials": true,
    "created_at": "2024-01-01T00:00:00Z",
    "email": "xia@localhost.localdomain",
    "phone": "415-555-5556",
    "street_address": "1 SaaS Road",
    "locality": "San Francisco",
    "region": "California",
    "postal_code": "94133",
    "country": "US",
    "default_timezone": "America/Los_Angeles",
    "is_provider": false,
    "is_bulk_buyer": false,
    "lang": "en",
    "extra": null
  },
  "originated_by": {
    "slug": "xia",
    "username": "xia",
    "printable_name": "Xia",
    "full_name": "Xia Lee",
    "nick_name": "Xia",
    "picture": null,
    "type": "personal",
    "credentials": true,
    "created_at": "2024-01-01T00:00:00Z",
    "last_login": "2024-01-01T00:00:00Z",
    "email": "xia@localhost.localdomain",
    "phone": "415-555-5556",
    "lang": "en",
    "extra": null
  },
  "user": {
    "slug": "emilie",
    "username": "emilie",
    "printable_name": "Emilie",
    "full_name": "Emilie Jolie",
    "nick_name": "Emilie",
    "picture": null,
    "type": "user",
    "credentials": false,
    "created_at": "2024-01-01T00:00:00Z",
    "last_login": "",
    "email": "emilie@localhost.localdomain",
    "phone": "415-555-5557",
    "lang": "en",
    "extra": null
  }
}

Subscription grant accepted

This notification is sent when a profile has accepted a subscription that was previously granted.

Definition

event

"subscription_grant_accepted"

broker

object

Site on which the product is hosted

slug

string

Unique identifier shown in the URL bar

printable_name

string

Name that can be safely used for display in HTML pages

picture

string

URL location of the profile picture

type

string

One of 'organization', 'personal' or 'user'

credentials

string

True if the account has valid login credentials

created_at

string

Date/time of creation (in ISO format)

full_name

string

Full name

string

E-mail address

phone

string

Phone number

street_address

string

Street address

locality

string

City/Town

region

string

State/Province/County

postal_code

string

Zip/Postal code

country

string

Country as 2-letter code (ISO 3166-1)

default_timezone

string

Timezone to use when reporting metrics

is_provider

boolean

The profile can fulfill the provider side of a subscription.

is_bulk_buyer

boolean

Enable GroupBuy

extra

string

Extra meta data (can be stringify JSON)

detail

string

Describes the result of the action in human-readable form

nick_name

string

Short casual name used to address the contact (only available for 'personal' and 'user' accounts)

lang

string

Preferred communication language (only available for 'personal' and 'user' accounts)

back_url

string

Link back to the site

profile

object

profile the notification relates to

slug

string

Unique identifier shown in the URL bar

printable_name

string

Name that can be safely used for display in HTML pages

picture

string

URL location of the profile picture

type

string

One of 'organization', 'personal' or 'user'

credentials

string

True if the account has valid login credentials

created_at

string

Date/time of creation (in ISO format)

full_name

string

Full name

string

E-mail address

phone

string

Phone number

street_address

string

Street address

locality

string

City/Town

region

string

State/Province/County

postal_code

string

Zip/Postal code

country

string

Country as 2-letter code (ISO 3166-1)

default_timezone

string

Timezone to use when reporting metrics

is_provider

boolean

The profile can fulfill the provider side of a subscription.

is_bulk_buyer

boolean

Enable GroupBuy

extra

string

Extra meta data (can be stringify JSON)

detail

string

Describes the result of the action in human-readable form

nick_name

string

Short casual name used to address the contact (only available for 'personal' and 'user' accounts)

lang

string

Preferred communication language (only available for 'personal' and 'user' accounts)

originated_by

object

the user at the origin of the notification

slug

string

Unique identifier that can safely be used in place of username

username

string

Unique identifier for the user, typically used in URLs

printable_name

string

Name that can be safely used for display in HTML pages

picture

string

URL location of the profile picture

string

Primary e-mail address to contact user

phone

string

Primary phone number to contact user

full_name

string

Full name (effectively first name followed by last name)

nick_name

string

Short casual name used to address the user

lang

string

Preferred communication language

credentials

string

True if the user has valid login credentials

otp_enabled

string

True if the user has valid login credentials

created_at

string

Date at which the user account was created

last_login

string

Date at which the user last logged in

email_code

integer

Email verification code

phone_code

integer

Phone verification code

provider

object

provider when different from broker

slug

string

Unique identifier shown in the URL bar

printable_name

string

Name that can be safely used for display in HTML pages

picture

string

URL location of the profile picture

type

string

One of 'organization', 'personal' or 'user'

credentials

string

True if the account has valid login credentials

created_at

string

Date/time of creation (in ISO format)

full_name

string

Full name

string

E-mail address

phone

string

Phone number

street_address

string

Street address

locality

string

City/Town

region

string

State/Province/County

postal_code

string

Zip/Postal code

country

string

Country as 2-letter code (ISO 3166-1)

default_timezone

string

Timezone to use when reporting metrics

is_provider

boolean

The profile can fulfill the provider side of a subscription.

is_bulk_buyer

boolean

Enable GroupBuy

extra

string

Extra meta data (can be stringify JSON)

detail

string

Describes the result of the action in human-readable form

nick_name

string

Short casual name used to address the contact (only available for 'personal' and 'user' accounts)

lang

string

Preferred communication language (only available for 'personal' and 'user' accounts)

plan

object

plan the subscription relates to

slug

string

Unique identifier shown in the URL bar

title

string

Title for the plan

Examples

{
  "event": "subscription_grant_accepted",
  "broker": {
    "slug": "djaoapp",
    "printable_name": "DjaoApp",
    "full_name": "DjaoApp inc.",
    "nick_name": "DjaoApp",
    "picture": null,
    "type": "organization",
    "credentials": false,
    "created_at": "2024-01-01T00:00:00Z",
    "email": "djaoapp@localhost.localdomain",
    "phone": "415-555-5555",
    "street_address": "1 SaaS Road",
    "locality": "San Francisco",
    "region": "California",
    "postal_code": "94133",
    "country": "US",
    "default_timezone": "America/Los_Angeles",
    "is_provider": true,
    "is_bulk_buyer": false,
    "lang": "en",
    "extra": null
  },
  "back_url": "http://localhost:8020",
  "profile": {
    "slug": "xia",
    "printable_name": "Xia",
    "full_name": "Xia Lee",
    "nick_name": "Xia",
    "picture": null,
    "type": "personal",
    "credentials": true,
    "created_at": "2024-01-01T00:00:00Z",
    "email": "xia@localhost.localdomain",
    "phone": "415-555-5556",
    "street_address": "1 SaaS Road",
    "locality": "San Francisco",
    "region": "California",
    "postal_code": "94133",
    "country": "US",
    "default_timezone": "America/Los_Angeles",
    "is_provider": false,
    "is_bulk_buyer": false,
    "lang": "en",
    "extra": null
  },
  "originated_by": {
    "slug": "xia",
    "username": "xia",
    "printable_name": "Xia",
    "full_name": "Xia Lee",
    "nick_name": "Xia",
    "picture": null,
    "type": "personal",
    "credentials": true,
    "created_at": "2024-01-01T00:00:00Z",
    "last_login": "2024-01-01T00:00:00Z",
    "email": "xia@localhost.localdomain",
    "phone": "415-555-5556",
    "lang": "en",
    "extra": null
  },
  "plan": {
    "slug": "premium",
    "title": "Premium"
  }
}

Subscription granted

This notification is sent when a profile is granted a subscription to a plan.

Definition

event

"subscription_grant_created"

broker

object

Site on which the product is hosted

slug

string

Unique identifier shown in the URL bar

printable_name

string

Name that can be safely used for display in HTML pages

picture

string

URL location of the profile picture

type

string

One of 'organization', 'personal' or 'user'

credentials

string

True if the account has valid login credentials

created_at

string

Date/time of creation (in ISO format)

full_name

string

Full name

string

E-mail address

phone

string

Phone number

street_address

string

Street address

locality

string

City/Town

region

string

State/Province/County

postal_code

string

Zip/Postal code

country

string

Country as 2-letter code (ISO 3166-1)

default_timezone

string

Timezone to use when reporting metrics

is_provider

boolean

The profile can fulfill the provider side of a subscription.

is_bulk_buyer

boolean

Enable GroupBuy

extra

string

Extra meta data (can be stringify JSON)

detail

string

Describes the result of the action in human-readable form

nick_name

string

Short casual name used to address the contact (only available for 'personal' and 'user' accounts)

lang

string

Preferred communication language (only available for 'personal' and 'user' accounts)

back_url

string

Link back to the site

profile

object

profile the notification relates to

slug

string

Unique identifier shown in the URL bar

printable_name

string

Name that can be safely used for display in HTML pages

picture

string

URL location of the profile picture

type

string

One of 'organization', 'personal' or 'user'

credentials

string

True if the account has valid login credentials

created_at

string

Date/time of creation (in ISO format)

full_name

string

Full name

string

E-mail address

phone

string

Phone number

street_address

string

Street address

locality

string

City/Town

region

string

State/Province/County

postal_code

string

Zip/Postal code

country

string

Country as 2-letter code (ISO 3166-1)

default_timezone

string

Timezone to use when reporting metrics

is_provider

boolean

The profile can fulfill the provider side of a subscription.

is_bulk_buyer

boolean

Enable GroupBuy

extra

string

Extra meta data (can be stringify JSON)

detail

string

Describes the result of the action in human-readable form

nick_name

string

Short casual name used to address the contact (only available for 'personal' and 'user' accounts)

lang

string

Preferred communication language (only available for 'personal' and 'user' accounts)

originated_by

object

the user at the origin of the notification

slug

string

Unique identifier that can safely be used in place of username

username

string

Unique identifier for the user, typically used in URLs

printable_name

string

Name that can be safely used for display in HTML pages

picture

string

URL location of the profile picture

string

Primary e-mail address to contact user

phone

string

Primary phone number to contact user

full_name

string

Full name (effectively first name followed by last name)

nick_name

string

Short casual name used to address the user

lang

string

Preferred communication language

credentials

string

True if the user has valid login credentials

otp_enabled

string

True if the user has valid login credentials

created_at

string

Date at which the user account was created

last_login

string

Date at which the user last logged in

email_code

integer

Email verification code

phone_code

integer

Phone verification code

provider

object

provider when different from broker

slug

string

Unique identifier shown in the URL bar

printable_name

string

Name that can be safely used for display in HTML pages

picture

string

URL location of the profile picture

type

string

One of 'organization', 'personal' or 'user'

credentials

string

True if the account has valid login credentials

created_at

string

Date/time of creation (in ISO format)

full_name

string

Full name

string

E-mail address

phone

string

Phone number

street_address

string

Street address

locality

string

City/Town

region

string

State/Province/County

postal_code

string

Zip/Postal code

country

string

Country as 2-letter code (ISO 3166-1)

default_timezone

string

Timezone to use when reporting metrics

is_provider

boolean

The profile can fulfill the provider side of a subscription.

is_bulk_buyer

boolean

Enable GroupBuy

extra

string

Extra meta data (can be stringify JSON)

detail

string

Describes the result of the action in human-readable form

nick_name

string

Short casual name used to address the contact (only available for 'personal' and 'user' accounts)

lang

string

Preferred communication language (only available for 'personal' and 'user' accounts)

plan

object

plan the subscription relates to

slug

string

Unique identifier shown in the URL bar

title

string

Title for the plan

detail

string

optional message at the attention of the profile

Examples

{
  "event": "subscription_grant_created",
  "broker": {
    "slug": "djaoapp",
    "printable_name": "DjaoApp",
    "full_name": "DjaoApp inc.",
    "nick_name": "DjaoApp",
    "picture": null,
    "type": "organization",
    "credentials": false,
    "created_at": "2024-01-01T00:00:00Z",
    "email": "djaoapp@localhost.localdomain",
    "phone": "415-555-5555",
    "street_address": "1 SaaS Road",
    "locality": "San Francisco",
    "region": "California",
    "postal_code": "94133",
    "country": "US",
    "default_timezone": "America/Los_Angeles",
    "is_provider": true,
    "is_bulk_buyer": false,
    "lang": "en",
    "extra": null
  },
  "back_url": "http://localhost:8020",
  "profile": {
    "slug": "xia",
    "printable_name": "Xia",
    "full_name": "Xia Lee",
    "nick_name": "Xia",
    "picture": null,
    "type": "personal",
    "credentials": true,
    "created_at": "2024-01-01T00:00:00Z",
    "email": "xia@localhost.localdomain",
    "phone": "415-555-5556",
    "street_address": "1 SaaS Road",
    "locality": "San Francisco",
    "region": "California",
    "postal_code": "94133",
    "country": "US",
    "default_timezone": "America/Los_Angeles",
    "is_provider": false,
    "is_bulk_buyer": false,
    "lang": "en",
    "extra": null
  },
  "originated_by": {
    "slug": "xia",
    "username": "xia",
    "printable_name": "Xia",
    "full_name": "Xia Lee",
    "nick_name": "Xia",
    "picture": null,
    "type": "personal",
    "credentials": true,
    "created_at": "2024-01-01T00:00:00Z",
    "last_login": "2024-01-01T00:00:00Z",
    "email": "xia@localhost.localdomain",
    "phone": "415-555-5556",
    "lang": "en",
    "extra": null
  },
  "plan": {
    "slug": "premium",
    "title": "Premium"
  }
}

Subscription request accepted

This notification is sent when a provider accepts to grant a subscription a profile previously requested.

Definition

event

"subscription_request_accepted"

broker

object

Site on which the product is hosted

slug

string

Unique identifier shown in the URL bar

printable_name

string

Name that can be safely used for display in HTML pages

picture

string

URL location of the profile picture

type

string

One of 'organization', 'personal' or 'user'

credentials

string

True if the account has valid login credentials

created_at

string

Date/time of creation (in ISO format)

full_name

string

Full name

string

E-mail address

phone

string

Phone number

street_address

string

Street address

locality

string

City/Town

region

string

State/Province/County

postal_code

string

Zip/Postal code

country

string

Country as 2-letter code (ISO 3166-1)

default_timezone

string

Timezone to use when reporting metrics

is_provider

boolean

The profile can fulfill the provider side of a subscription.

is_bulk_buyer

boolean

Enable GroupBuy

extra

string

Extra meta data (can be stringify JSON)

detail

string

Describes the result of the action in human-readable form

nick_name

string

Short casual name used to address the contact (only available for 'personal' and 'user' accounts)

lang

string

Preferred communication language (only available for 'personal' and 'user' accounts)

back_url

string

Link back to the site

profile

object

profile the notification relates to

slug

string

Unique identifier shown in the URL bar

printable_name

string

Name that can be safely used for display in HTML pages

picture

string

URL location of the profile picture

type

string

One of 'organization', 'personal' or 'user'

credentials

string

True if the account has valid login credentials

created_at

string

Date/time of creation (in ISO format)

full_name

string

Full name

string

E-mail address

phone

string

Phone number

street_address

string

Street address

locality

string

City/Town

region

string

State/Province/County

postal_code

string

Zip/Postal code

country

string

Country as 2-letter code (ISO 3166-1)

default_timezone

string

Timezone to use when reporting metrics

is_provider

boolean

The profile can fulfill the provider side of a subscription.

is_bulk_buyer

boolean

Enable GroupBuy

extra

string

Extra meta data (can be stringify JSON)

detail

string

Describes the result of the action in human-readable form

nick_name

string

Short casual name used to address the contact (only available for 'personal' and 'user' accounts)

lang

string

Preferred communication language (only available for 'personal' and 'user' accounts)

originated_by

object

the user at the origin of the notification

slug

string

Unique identifier that can safely be used in place of username

username

string

Unique identifier for the user, typically used in URLs

printable_name

string

Name that can be safely used for display in HTML pages

picture

string

URL location of the profile picture

string

Primary e-mail address to contact user

phone

string

Primary phone number to contact user

full_name

string

Full name (effectively first name followed by last name)

nick_name

string

Short casual name used to address the user

lang

string

Preferred communication language

credentials

string

True if the user has valid login credentials

otp_enabled

string

True if the user has valid login credentials

created_at

string

Date at which the user account was created

last_login

string

Date at which the user last logged in

email_code

integer

Email verification code

phone_code

integer

Phone verification code

provider

object

provider when different from broker

slug

string

Unique identifier shown in the URL bar

printable_name

string

Name that can be safely used for display in HTML pages

picture

string

URL location of the profile picture

type

string

One of 'organization', 'personal' or 'user'

credentials

string

True if the account has valid login credentials

created_at

string

Date/time of creation (in ISO format)

full_name

string

Full name

string

E-mail address

phone

string

Phone number

street_address

string

Street address

locality

string

City/Town

region

string

State/Province/County

postal_code

string

Zip/Postal code

country

string

Country as 2-letter code (ISO 3166-1)

default_timezone

string

Timezone to use when reporting metrics

is_provider

boolean

The profile can fulfill the provider side of a subscription.

is_bulk_buyer

boolean

Enable GroupBuy

extra

string

Extra meta data (can be stringify JSON)

detail

string

Describes the result of the action in human-readable form

nick_name

string

Short casual name used to address the contact (only available for 'personal' and 'user' accounts)

lang

string

Preferred communication language (only available for 'personal' and 'user' accounts)

plan

object

plan the subscription relates to

slug

string

Unique identifier shown in the URL bar

title

string

Title for the plan

Examples

{
  "event": "subscription_request_accepted",
  "broker": {
    "slug": "djaoapp",
    "printable_name": "DjaoApp",
    "full_name": "DjaoApp inc.",
    "nick_name": "DjaoApp",
    "picture": null,
    "type": "organization",
    "credentials": false,
    "created_at": "2024-01-01T00:00:00Z",
    "email": "djaoapp@localhost.localdomain",
    "phone": "415-555-5555",
    "street_address": "1 SaaS Road",
    "locality": "San Francisco",
    "region": "California",
    "postal_code": "94133",
    "country": "US",
    "default_timezone": "America/Los_Angeles",
    "is_provider": true,
    "is_bulk_buyer": false,
    "lang": "en",
    "extra": null
  },
  "back_url": "http://localhost:8020",
  "profile": {
    "slug": "xia",
    "printable_name": "Xia",
    "full_name": "Xia Lee",
    "nick_name": "Xia",
    "picture": null,
    "type": "personal",
    "credentials": true,
    "created_at": "2024-01-01T00:00:00Z",
    "email": "xia@localhost.localdomain",
    "phone": "415-555-5556",
    "street_address": "1 SaaS Road",
    "locality": "San Francisco",
    "region": "California",
    "postal_code": "94133",
    "country": "US",
    "default_timezone": "America/Los_Angeles",
    "is_provider": false,
    "is_bulk_buyer": false,
    "lang": "en",
    "extra": null
  },
  "originated_by": {
    "slug": "xia",
    "username": "xia",
    "printable_name": "Xia",
    "full_name": "Xia Lee",
    "nick_name": "Xia",
    "picture": null,
    "type": "personal",
    "credentials": true,
    "created_at": "2024-01-01T00:00:00Z",
    "last_login": "2024-01-01T00:00:00Z",
    "email": "xia@localhost.localdomain",
    "phone": "415-555-5556",
    "lang": "en",
    "extra": null
  },
  "plan": {
    "slug": "premium",
    "title": "Premium"
  }
}

Subscription requested

This notification is sent when a profile is requesting a subscription to a plan.

Definition

event

"subscription_request_created"

broker

object

Site on which the product is hosted

slug

string

Unique identifier shown in the URL bar

printable_name

string

Name that can be safely used for display in HTML pages

picture

string

URL location of the profile picture

type

string

One of 'organization', 'personal' or 'user'

credentials

string

True if the account has valid login credentials

created_at

string

Date/time of creation (in ISO format)

full_name

string

Full name

string

E-mail address

phone

string

Phone number

street_address

string

Street address

locality

string

City/Town

region

string

State/Province/County

postal_code

string

Zip/Postal code

country

string

Country as 2-letter code (ISO 3166-1)

default_timezone

string

Timezone to use when reporting metrics

is_provider

boolean

The profile can fulfill the provider side of a subscription.

is_bulk_buyer

boolean

Enable GroupBuy

extra

string

Extra meta data (can be stringify JSON)

detail

string

Describes the result of the action in human-readable form

nick_name

string

Short casual name used to address the contact (only available for 'personal' and 'user' accounts)

lang

string

Preferred communication language (only available for 'personal' and 'user' accounts)

back_url

string

Link back to the site

profile

object

profile the notification relates to

slug

string

Unique identifier shown in the URL bar

printable_name

string

Name that can be safely used for display in HTML pages

picture

string

URL location of the profile picture

type

string

One of 'organization', 'personal' or 'user'

credentials

string

True if the account has valid login credentials

created_at

string

Date/time of creation (in ISO format)

full_name

string

Full name

string

E-mail address

phone

string

Phone number

street_address

string

Street address

locality

string

City/Town

region

string

State/Province/County

postal_code

string

Zip/Postal code

country

string

Country as 2-letter code (ISO 3166-1)

default_timezone

string

Timezone to use when reporting metrics

is_provider

boolean

The profile can fulfill the provider side of a subscription.

is_bulk_buyer

boolean

Enable GroupBuy

extra

string

Extra meta data (can be stringify JSON)

detail

string

Describes the result of the action in human-readable form

nick_name

string

Short casual name used to address the contact (only available for 'personal' and 'user' accounts)

lang

string

Preferred communication language (only available for 'personal' and 'user' accounts)

originated_by

object

the user at the origin of the notification

slug

string

Unique identifier that can safely be used in place of username

username

string

Unique identifier for the user, typically used in URLs

printable_name

string

Name that can be safely used for display in HTML pages

picture

string

URL location of the profile picture

string

Primary e-mail address to contact user

phone

string

Primary phone number to contact user

full_name

string

Full name (effectively first name followed by last name)

nick_name

string

Short casual name used to address the user

lang

string

Preferred communication language

credentials

string

True if the user has valid login credentials

otp_enabled

string

True if the user has valid login credentials

created_at

string

Date at which the user account was created

last_login

string

Date at which the user last logged in

email_code

integer

Email verification code

phone_code

integer

Phone verification code

provider

object

provider when different from broker

slug

string

Unique identifier shown in the URL bar

printable_name

string

Name that can be safely used for display in HTML pages

picture

string

URL location of the profile picture

type

string

One of 'organization', 'personal' or 'user'

credentials

string

True if the account has valid login credentials

created_at

string

Date/time of creation (in ISO format)

full_name

string

Full name

string

E-mail address

phone

string

Phone number

street_address

string

Street address

locality

string

City/Town

region

string

State/Province/County

postal_code

string

Zip/Postal code

country

string

Country as 2-letter code (ISO 3166-1)

default_timezone

string

Timezone to use when reporting metrics

is_provider

boolean

The profile can fulfill the provider side of a subscription.

is_bulk_buyer

boolean

Enable GroupBuy

extra

string

Extra meta data (can be stringify JSON)

detail

string

Describes the result of the action in human-readable form

nick_name

string

Short casual name used to address the contact (only available for 'personal' and 'user' accounts)

lang

string

Preferred communication language (only available for 'personal' and 'user' accounts)

plan

object

plan the subscription relates to

slug

string

Unique identifier shown in the URL bar

title

string

Title for the plan

detail

string

optional message at the attention of the profile

Examples

{
  "event": "subscription_request_created",
  "broker": {
    "slug": "djaoapp",
    "printable_name": "DjaoApp",
    "full_name": "DjaoApp inc.",
    "nick_name": "DjaoApp",
    "picture": null,
    "type": "organization",
    "credentials": false,
    "created_at": "2024-01-01T00:00:00Z",
    "email": "djaoapp@localhost.localdomain",
    "phone": "415-555-5555",
    "street_address": "1 SaaS Road",
    "locality": "San Francisco",
    "region": "California",
    "postal_code": "94133",
    "country": "US",
    "default_timezone": "America/Los_Angeles",
    "is_provider": true,
    "is_bulk_buyer": false,
    "lang": "en",
    "extra": null
  },
  "back_url": "http://localhost:8020",
  "profile": {
    "slug": "xia",
    "printable_name": "Xia",
    "full_name": "Xia Lee",
    "nick_name": "Xia",
    "picture": null,
    "type": "personal",
    "credentials": true,
    "created_at": "2024-01-01T00:00:00Z",
    "email": "xia@localhost.localdomain",
    "phone": "415-555-5556",
    "street_address": "1 SaaS Road",
    "locality": "San Francisco",
    "region": "California",
    "postal_code": "94133",
    "country": "US",
    "default_timezone": "America/Los_Angeles",
    "is_provider": false,
    "is_bulk_buyer": false,
    "lang": "en",
    "extra": null
  },
  "originated_by": {
    "slug": "xia",
    "username": "xia",
    "printable_name": "Xia",
    "full_name": "Xia Lee",
    "nick_name": "Xia",
    "picture": null,
    "type": "personal",
    "credentials": true,
    "created_at": "2024-01-01T00:00:00Z",
    "last_login": "2024-01-01T00:00:00Z",
    "email": "xia@localhost.localdomain",
    "phone": "415-555-5556",
    "lang": "en",
    "extra": null
  },
  "plan": {
    "slug": "premium",
    "title": "Premium"
  }
}

Use charge limit crossed

This notification is sent when a profile has passed the maximum limit to bill within a period for use charges.

Definition

event

"use_charge_limit_crossed"

broker

object

Site on which the product is hosted

slug

string

Unique identifier shown in the URL bar

printable_name

string

Name that can be safely used for display in HTML pages

picture

string

URL location of the profile picture

type

string

One of 'organization', 'personal' or 'user'

credentials

string

True if the account has valid login credentials

created_at

string

Date/time of creation (in ISO format)

full_name

string

Full name

string

E-mail address

phone

string

Phone number

street_address

string

Street address

locality

string

City/Town

region

string

State/Province/County

postal_code

string

Zip/Postal code

country

string

Country as 2-letter code (ISO 3166-1)

default_timezone

string

Timezone to use when reporting metrics

is_provider

boolean

The profile can fulfill the provider side of a subscription.

is_bulk_buyer

boolean

Enable GroupBuy

extra

string

Extra meta data (can be stringify JSON)

detail

string

Describes the result of the action in human-readable form

nick_name

string

Short casual name used to address the contact (only available for 'personal' and 'user' accounts)

lang

string

Preferred communication language (only available for 'personal' and 'user' accounts)

back_url

string

Link back to the site

profile

object

profile the notification relates to

slug

string

Unique identifier shown in the URL bar

printable_name

string

Name that can be safely used for display in HTML pages

picture

string

URL location of the profile picture

type

string

One of 'organization', 'personal' or 'user'

credentials

string

True if the account has valid login credentials

created_at

string

Date/time of creation (in ISO format)

full_name

string

Full name

string

E-mail address

phone

string

Phone number

street_address

string

Street address

locality

string

City/Town

region

string

State/Province/County

postal_code

string

Zip/Postal code

country

string

Country as 2-letter code (ISO 3166-1)

default_timezone

string

Timezone to use when reporting metrics

is_provider

boolean

The profile can fulfill the provider side of a subscription.

is_bulk_buyer

boolean

Enable GroupBuy

extra

string

Extra meta data (can be stringify JSON)

detail

string

Describes the result of the action in human-readable form

nick_name

string

Short casual name used to address the contact (only available for 'personal' and 'user' accounts)

lang

string

Preferred communication language (only available for 'personal' and 'user' accounts)

plan

object

plan the subscription relates to

slug

string

Unique identifier shown in the URL bar

title

string

Title for the plan

provider

object

provider when different from broker

slug

string

Unique identifier shown in the URL bar

printable_name

string

Name that can be safely used for display in HTML pages

picture

string

URL location of the profile picture

type

string

One of 'organization', 'personal' or 'user'

credentials

string

True if the account has valid login credentials

created_at

string

Date/time of creation (in ISO format)

full_name

string

Full name

string

E-mail address

phone

string

Phone number

street_address

string

Street address

locality

string

City/Town

region

string

State/Province/County

postal_code

string

Zip/Postal code

country

string

Country as 2-letter code (ISO 3166-1)

default_timezone

string

Timezone to use when reporting metrics

is_provider

boolean

The profile can fulfill the provider side of a subscription.

is_bulk_buyer

boolean

Enable GroupBuy

extra

string

Extra meta data (can be stringify JSON)

detail

string

Describes the result of the action in human-readable form

nick_name

string

Short casual name used to address the contact (only available for 'personal' and 'user' accounts)

lang

string

Preferred communication language (only available for 'personal' and 'user' accounts)

use_charge

object

use charge the notification relates to

slug

string

Unique identifier shown in the URL bar

title

string

Short description of the use charge

description

string

Long description of the use charge

created_at

string

Date/time of creation (in ISO format)

use_amount

integer

Amount per unit defined by the provider of the use charge in plan currency unit (ex: $0.01/request)

quota

integer

Usage included in the plan (in units defined by the provider)

maximum_limit

integer

Maximum spend limit per period above which the subscriber is notified (in currency unit)

extra

string

Extra meta data (can be stringify JSON)

usage

integer

current usage in billing period

Examples

{
  "event": "use_charge_limit_crossed",
  "broker": {
    "slug": "djaoapp",
    "printable_name": "DjaoApp",
    "full_name": "DjaoApp inc.",
    "nick_name": "DjaoApp",
    "picture": null,
    "type": "organization",
    "credentials": false,
    "created_at": "2024-01-01T00:00:00Z",
    "email": "djaoapp@localhost.localdomain",
    "phone": "415-555-5555",
    "street_address": "1 SaaS Road",
    "locality": "San Francisco",
    "region": "California",
    "postal_code": "94133",
    "country": "US",
    "default_timezone": "America/Los_Angeles",
    "is_provider": true,
    "is_bulk_buyer": false,
    "lang": "en",
    "extra": null
  },
  "back_url": "http://localhost:8020",
  "profile": {
    "slug": "xia",
    "printable_name": "Xia",
    "full_name": "Xia Lee",
    "nick_name": "Xia",
    "picture": null,
    "type": "personal",
    "credentials": true,
    "created_at": "2024-01-01T00:00:00Z",
    "email": "xia@localhost.localdomain",
    "phone": "415-555-5556",
    "street_address": "1 SaaS Road",
    "locality": "San Francisco",
    "region": "California",
    "postal_code": "94133",
    "country": "US",
    "default_timezone": "America/Los_Angeles",
    "is_provider": false,
    "is_bulk_buyer": false,
    "lang": "en",
    "extra": null
  },
  "plan": {
    "slug": "premium",
    "title": "Premium"
  },
  "use_charge": {
    "slug": "http-requests",
    "title": "Number of HTTP requests",
    "description": "",
    "created_at": "2024-01-01T00:00:00Z",
    "use_amount": 1,
    "quota": 100000,
    "maximum_limit": 1000000,
    "extra": null
  },
  "usage": 1000008
}

User activated

This notification is sent when a user has activated his/her account.

Definition

event

"user_activated"

broker

object

Site on which the product is hosted

slug

string

Unique identifier shown in the URL bar

printable_name

string

Name that can be safely used for display in HTML pages

picture

string

URL location of the profile picture

type

string

One of 'organization', 'personal' or 'user'

credentials

string

True if the account has valid login credentials

created_at

string

Date/time of creation (in ISO format)

full_name

string

Full name

string

E-mail address

phone

string

Phone number

street_address

string

Street address

locality

string

City/Town

region

string

State/Province/County

postal_code

string

Zip/Postal code

country

string

Country as 2-letter code (ISO 3166-1)

default_timezone

string

Timezone to use when reporting metrics

is_provider

boolean

The profile can fulfill the provider side of a subscription.

is_bulk_buyer

boolean

Enable GroupBuy

extra

string

Extra meta data (can be stringify JSON)

detail

string

Describes the result of the action in human-readable form

nick_name

string

Short casual name used to address the contact (only available for 'personal' and 'user' accounts)

lang

string

Preferred communication language (only available for 'personal' and 'user' accounts)

back_url

string

Link back to the site

user

object

user the notification applies to

slug

string

Unique identifier that can safely be used in place of username

username

string

Unique identifier for the user, typically used in URLs

printable_name

string

Name that can be safely used for display in HTML pages

picture

string

URL location of the profile picture

string

Primary e-mail address to contact user

phone

string

Primary phone number to contact user

full_name

string

Full name (effectively first name followed by last name)

nick_name

string

Short casual name used to address the user

lang

string

Preferred communication language

credentials

string

True if the user has valid login credentials

otp_enabled

string

True if the user has valid login credentials

created_at

string

Date at which the user account was created

last_login

string

Date at which the user last logged in

email_code

integer

Email verification code

phone_code

integer

Phone verification code

Examples

{
  "event": "user_activated",
  "broker": {
    "slug": "djaoapp",
    "printable_name": "DjaoApp",
    "full_name": "DjaoApp inc.",
    "nick_name": "DjaoApp",
    "picture": null,
    "type": "organization",
    "credentials": false,
    "created_at": "2024-01-01T00:00:00Z",
    "email": "djaoapp@localhost.localdomain",
    "phone": "415-555-5555",
    "street_address": "1 SaaS Road",
    "locality": "San Francisco",
    "region": "California",
    "postal_code": "94133",
    "country": "US",
    "default_timezone": "America/Los_Angeles",
    "is_provider": true,
    "is_bulk_buyer": false,
    "lang": "en",
    "extra": null
  },
  "back_url": "http://localhost:8020",
  "user": {
    "slug": "xia",
    "username": "xia",
    "printable_name": "Xia",
    "full_name": "Xia Lee",
    "nick_name": "Xia",
    "picture": null,
    "type": "personal",
    "credentials": true,
    "created_at": "2024-01-01T00:00:00Z",
    "last_login": "2024-01-01T00:00:00Z",
    "email": "xia@localhost.localdomain",
    "phone": "415-555-5556",
    "lang": "en",
    "extra": null
  }
}

Contact us

Someone requested information through the contact form.

Definition

event

"user_contact"

broker

object

Site on which the product is hosted

slug

string

Unique identifier shown in the URL bar

printable_name

string

Name that can be safely used for display in HTML pages

picture

string

URL location of the profile picture

type

string

One of 'organization', 'personal' or 'user'

credentials

string

True if the account has valid login credentials

created_at

string

Date/time of creation (in ISO format)

full_name

string

Full name

string

E-mail address

phone

string

Phone number

street_address

string

Street address

locality

string

City/Town

region

string

State/Province/County

postal_code

string

Zip/Postal code

country

string

Country as 2-letter code (ISO 3166-1)

default_timezone

string

Timezone to use when reporting metrics

is_provider

boolean

The profile can fulfill the provider side of a subscription.

is_bulk_buyer

boolean

Enable GroupBuy

extra

string

Extra meta data (can be stringify JSON)

detail

string

Describes the result of the action in human-readable form

nick_name

string

Short casual name used to address the contact (only available for 'personal' and 'user' accounts)

lang

string

Preferred communication language (only available for 'personal' and 'user' accounts)

back_url

string

Link back to the site

originated_by

object

the user at the origin of the notification

slug

string

Unique identifier that can safely be used in place of username

username

string

Unique identifier for the user, typically used in URLs

printable_name

string

Name that can be safely used for display in HTML pages

picture

string

URL location of the profile picture

string

Primary e-mail address to contact user

phone

string

Primary phone number to contact user

full_name

string

Full name (effectively first name followed by last name)

nick_name

string

Short casual name used to address the user

lang

string

Preferred communication language

credentials

string

True if the user has valid login credentials

otp_enabled

string

True if the user has valid login credentials

created_at

string

Date at which the user account was created

last_login

string

Date at which the user last logged in

email_code

integer

Email verification code

phone_code

integer

Phone verification code

provider

object

provider when different from broker

slug

string

Unique identifier shown in the URL bar

printable_name

string

Name that can be safely used for display in HTML pages

picture

string

URL location of the profile picture

type

string

One of 'organization', 'personal' or 'user'

credentials

string

True if the account has valid login credentials

created_at

string

Date/time of creation (in ISO format)

full_name

string

Full name

string

E-mail address

phone

string

Phone number

street_address

string

Street address

locality

string

City/Town

region

string

State/Province/County

postal_code

string

Zip/Postal code

country

string

Country as 2-letter code (ISO 3166-1)

default_timezone

string

Timezone to use when reporting metrics

is_provider

boolean

The profile can fulfill the provider side of a subscription.

is_bulk_buyer

boolean

Enable GroupBuy

extra

string

Extra meta data (can be stringify JSON)

detail

string

Describes the result of the action in human-readable form

nick_name

string

Short casual name used to address the contact (only available for 'personal' and 'user' accounts)

lang

string

Preferred communication language (only available for 'personal' and 'user' accounts)

detail

array

information passed in the 'Contact us' form, including message

Examples

{
  "event": "user_contact",
  "broker": {
    "slug": "djaoapp",
    "printable_name": "DjaoApp",
    "full_name": "DjaoApp inc.",
    "nick_name": "DjaoApp",
    "picture": null,
    "type": "organization",
    "credentials": false,
    "created_at": "2024-01-01T00:00:00Z",
    "email": "djaoapp@localhost.localdomain",
    "phone": "415-555-5555",
    "street_address": "1 SaaS Road",
    "locality": "San Francisco",
    "region": "California",
    "postal_code": "94133",
    "country": "US",
    "default_timezone": "America/Los_Angeles",
    "is_provider": true,
    "is_bulk_buyer": false,
    "lang": "en",
    "extra": null
  },
  "back_url": "http://localhost:8020",
  "originated_by": {
    "slug": "xia",
    "username": "xia",
    "printable_name": "Xia",
    "full_name": "Xia Lee",
    "nick_name": "Xia",
    "picture": null,
    "type": "personal",
    "credentials": true,
    "created_at": "2024-01-01T00:00:00Z",
    "last_login": "2024-01-01T00:00:00Z",
    "email": "xia@localhost.localdomain",
    "phone": "415-555-5556",
    "lang": "en",
    "extra": null
  },
  "detail": [
    [
      "Message",
      "Please help!"
    ]
  ]
}

User logged in

This notification is sent when a user logged in successfully.

Definition

event

"user_logged_in"

broker

object

Site on which the product is hosted

slug

string

Unique identifier shown in the URL bar

printable_name

string

Name that can be safely used for display in HTML pages

picture

string

URL location of the profile picture

type

string

One of 'organization', 'personal' or 'user'

credentials

string

True if the account has valid login credentials

created_at

string

Date/time of creation (in ISO format)

full_name

string

Full name

string

E-mail address

phone

string

Phone number

street_address

string

Street address

locality

string

City/Town

region

string

State/Province/County

postal_code

string

Zip/Postal code

country

string

Country as 2-letter code (ISO 3166-1)

default_timezone

string

Timezone to use when reporting metrics

is_provider

boolean

The profile can fulfill the provider side of a subscription.

is_bulk_buyer

boolean

Enable GroupBuy

extra

string

Extra meta data (can be stringify JSON)

detail

string

Describes the result of the action in human-readable form

nick_name

string

Short casual name used to address the contact (only available for 'personal' and 'user' accounts)

lang

string

Preferred communication language (only available for 'personal' and 'user' accounts)

back_url

string

Link back to the site

user

object

user the notification applies to

slug

string

Unique identifier that can safely be used in place of username

username

string

Unique identifier for the user, typically used in URLs

printable_name

string

Name that can be safely used for display in HTML pages

picture

string

URL location of the profile picture

string

Primary e-mail address to contact user

phone

string

Primary phone number to contact user

full_name

string

Full name (effectively first name followed by last name)

nick_name

string

Short casual name used to address the user

lang

string

Preferred communication language

credentials

string

True if the user has valid login credentials

otp_enabled

string

True if the user has valid login credentials

created_at

string

Date at which the user account was created

last_login

string

Date at which the user last logged in

email_code

integer

Email verification code

phone_code

integer

Phone verification code

Examples

{
  "event": "user_logged_in",
  "broker": {
    "slug": "djaoapp",
    "printable_name": "DjaoApp",
    "full_name": "DjaoApp inc.",
    "nick_name": "DjaoApp",
    "picture": null,
    "type": "organization",
    "credentials": false,
    "created_at": "2024-01-01T00:00:00Z",
    "email": "djaoapp@localhost.localdomain",
    "phone": "415-555-5555",
    "street_address": "1 SaaS Road",
    "locality": "San Francisco",
    "region": "California",
    "postal_code": "94133",
    "country": "US",
    "default_timezone": "America/Los_Angeles",
    "is_provider": true,
    "is_bulk_buyer": false,
    "lang": "en",
    "extra": null
  },
  "back_url": "http://localhost:8020",
  "user": {
    "slug": "xia",
    "username": "xia",
    "printable_name": "Xia",
    "full_name": "Xia Lee",
    "nick_name": "Xia",
    "picture": null,
    "type": "personal",
    "credentials": true,
    "created_at": "2024-01-01T00:00:00Z",
    "last_login": "2024-01-01T00:00:00Z",
    "email": "xia@localhost.localdomain",
    "phone": "415-555-5556",
    "lang": "en",
    "extra": null
  }
}

User login failed

This notification is sent when a user login attempts has failed.

Definition

event

"user_login_failed"

broker

object

Site on which the product is hosted

slug

string

Unique identifier shown in the URL bar

printable_name

string

Name that can be safely used for display in HTML pages

picture

string

URL location of the profile picture

type

string

One of 'organization', 'personal' or 'user'

credentials

string

True if the account has valid login credentials

created_at

string

Date/time of creation (in ISO format)

full_name

string

Full name

string

E-mail address

phone

string

Phone number

street_address

string

Street address

locality

string

City/Town

region

string

State/Province/County

postal_code

string

Zip/Postal code

country

string

Country as 2-letter code (ISO 3166-1)

default_timezone

string

Timezone to use when reporting metrics

is_provider

boolean

The profile can fulfill the provider side of a subscription.

is_bulk_buyer

boolean

Enable GroupBuy

extra

string

Extra meta data (can be stringify JSON)

detail

string

Describes the result of the action in human-readable form

nick_name

string

Short casual name used to address the contact (only available for 'personal' and 'user' accounts)

lang

string

Preferred communication language (only available for 'personal' and 'user' accounts)

back_url

string

Link back to the site

user

object

user the notification applies to

slug

string

Unique identifier that can safely be used in place of username

username

string

Unique identifier for the user, typically used in URLs

printable_name

string

Name that can be safely used for display in HTML pages

picture

string

URL location of the profile picture

string

Primary e-mail address to contact user

phone

string

Primary phone number to contact user

full_name

string

Full name (effectively first name followed by last name)

nick_name

string

Short casual name used to address the user

lang

string

Preferred communication language

credentials

string

True if the user has valid login credentials

otp_enabled

string

True if the user has valid login credentials

created_at

string

Date at which the user account was created

last_login

string

Date at which the user last logged in

email_code

integer

Email verification code

phone_code

integer

Phone verification code

Examples

{
  "event": "user_login_failed",
  "broker": {
    "slug": "djaoapp",
    "printable_name": "DjaoApp",
    "full_name": "DjaoApp inc.",
    "nick_name": "DjaoApp",
    "picture": null,
    "type": "organization",
    "credentials": false,
    "created_at": "2024-01-01T00:00:00Z",
    "email": "djaoapp@localhost.localdomain",
    "phone": "415-555-5555",
    "street_address": "1 SaaS Road",
    "locality": "San Francisco",
    "region": "California",
    "postal_code": "94133",
    "country": "US",
    "default_timezone": "America/Los_Angeles",
    "is_provider": true,
    "is_bulk_buyer": false,
    "lang": "en",
    "extra": null
  },
  "back_url": "http://localhost:8020/recover/",
  "user": {
    "slug": "xia",
    "username": "xia",
    "printable_name": "Xia",
    "full_name": "Xia Lee",
    "nick_name": "Xia",
    "picture": null,
    "type": "personal",
    "credentials": true,
    "created_at": "2024-01-01T00:00:00Z",
    "last_login": "2024-01-01T00:00:00Z",
    "email": "xia@localhost.localdomain",
    "phone": "415-555-5556",
    "lang": "en",
    "extra": null
  }
}

User registered

This notification is sent when a user has registered.

Definition

event

"user_registered"

broker

object

Site on which the product is hosted

slug

string

Unique identifier shown in the URL bar

printable_name

string

Name that can be safely used for display in HTML pages

picture

string

URL location of the profile picture

type

string

One of 'organization', 'personal' or 'user'

credentials

string

True if the account has valid login credentials

created_at

string

Date/time of creation (in ISO format)

full_name

string

Full name

string

E-mail address

phone

string

Phone number

street_address

string

Street address

locality

string

City/Town

region

string

State/Province/County

postal_code

string

Zip/Postal code

country

string

Country as 2-letter code (ISO 3166-1)

default_timezone

string

Timezone to use when reporting metrics

is_provider

boolean

The profile can fulfill the provider side of a subscription.

is_bulk_buyer

boolean

Enable GroupBuy

extra

string

Extra meta data (can be stringify JSON)

detail

string

Describes the result of the action in human-readable form

nick_name

string

Short casual name used to address the contact (only available for 'personal' and 'user' accounts)

lang

string

Preferred communication language (only available for 'personal' and 'user' accounts)

back_url

string

Link back to the site

user

object

user the notification applies to

slug

string

Unique identifier that can safely be used in place of username

username

string

Unique identifier for the user, typically used in URLs

printable_name

string

Name that can be safely used for display in HTML pages

picture

string

URL location of the profile picture

string

Primary e-mail address to contact user

phone

string

Primary phone number to contact user

full_name

string

Full name (effectively first name followed by last name)

nick_name

string

Short casual name used to address the user

lang

string

Preferred communication language

credentials

string

True if the user has valid login credentials

otp_enabled

string

True if the user has valid login credentials

created_at

string

Date at which the user account was created

last_login

string

Date at which the user last logged in

email_code

integer

Email verification code

phone_code

integer

Phone verification code

Examples

{
  "event": "user_registered",
  "broker": {
    "slug": "djaoapp",
    "printable_name": "DjaoApp",
    "full_name": "DjaoApp inc.",
    "nick_name": "DjaoApp",
    "picture": null,
    "type": "organization",
    "credentials": false,
    "created_at": "2024-01-01T00:00:00Z",
    "email": "djaoapp@localhost.localdomain",
    "phone": "415-555-5555",
    "street_address": "1 SaaS Road",
    "locality": "San Francisco",
    "region": "California",
    "postal_code": "94133",
    "country": "US",
    "default_timezone": "America/Los_Angeles",
    "is_provider": true,
    "is_bulk_buyer": false,
    "lang": "en",
    "extra": null
  },
  "back_url": "http://localhost:8020",
  "user": {
    "slug": "xia",
    "username": "xia",
    "printable_name": "Xia",
    "full_name": "Xia Lee",
    "nick_name": "Xia",
    "picture": null,
    "type": "personal",
    "credentials": true,
    "created_at": "2024-01-01T00:00:00Z",
    "last_login": "2024-01-01T00:00:00Z",
    "email": "xia@localhost.localdomain",
    "phone": "415-555-5556",
    "lang": "en",
    "extra": null
  }
}