DjaoApp Notifications Reference
These are notifications sent by DjaoApp.
You can edit the notification e-mail templates in the Themes dashboard page.
Card expires soon
This notification is sent when a credit card on file is about to expire.
Definition
Site on which the product is hosted
Unique identifier shown in the URL bar
Name that can be safely used for display in HTML pages
URL location of the profile picture
One of 'organization', 'personal' or 'user'
True if the account has valid login credentials
Date/time of creation (in ISO format)
Full name
E-mail address
Phone number
Street address
City/Town
State/Province/County
Zip/Postal code
Country as 2-letter code (ISO 3166-1)
Timezone to use when reporting metrics
The profile can fulfill the provider side of a subscription.
Enable GroupBuy
Extra meta data (can be stringify JSON)
Describes the result of the action in human-readable form
Short casual name used to address the contact (only available for 'personal' and 'user' accounts)
Preferred communication language (only available for 'personal' and 'user' accounts)
Link back to the site
profile the notification relates to
Unique identifier shown in the URL bar
Name that can be safely used for display in HTML pages
URL location of the profile picture
One of 'organization', 'personal' or 'user'
True if the account has valid login credentials
Date/time of creation (in ISO format)
Full name
E-mail address
Phone number
Street address
City/Town
State/Province/County
Zip/Postal code
Country as 2-letter code (ISO 3166-1)
Timezone to use when reporting metrics
The profile can fulfill the provider side of a subscription.
Enable GroupBuy
Extra meta data (can be stringify JSON)
Describes the result of the action in human-readable form
Short casual name used to address the contact (only available for 'personal' and 'user' accounts)
Preferred communication language (only available for 'personal' and 'user' accounts)
number of days before the card expires
Last 4 digits of the credit card on file
Expiration date of the credit card on file
{
"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
Site on which the product is hosted
Unique identifier shown in the URL bar
Name that can be safely used for display in HTML pages
URL location of the profile picture
One of 'organization', 'personal' or 'user'
True if the account has valid login credentials
Date/time of creation (in ISO format)
Full name
E-mail address
Phone number
Street address
City/Town
State/Province/County
Zip/Postal code
Country as 2-letter code (ISO 3166-1)
Timezone to use when reporting metrics
The profile can fulfill the provider side of a subscription.
Enable GroupBuy
Extra meta data (can be stringify JSON)
Describes the result of the action in human-readable form
Short casual name used to address the contact (only available for 'personal' and 'user' accounts)
Preferred communication language (only available for 'personal' and 'user' accounts)
Link back to the site
profile the notification relates to
Unique identifier shown in the URL bar
Name that can be safely used for display in HTML pages
URL location of the profile picture
One of 'organization', 'personal' or 'user'
True if the account has valid login credentials
Date/time of creation (in ISO format)
Full name
E-mail address
Phone number
Street address
City/Town
State/Province/County
Zip/Postal code
Country as 2-letter code (ISO 3166-1)
Timezone to use when reporting metrics
The profile can fulfill the provider side of a subscription.
Enable GroupBuy
Extra meta data (can be stringify JSON)
Describes the result of the action in human-readable form
Short casual name used to address the contact (only available for 'personal' and 'user' accounts)
Preferred communication language (only available for 'personal' and 'user' accounts)
the user at the origin of the notification
Unique identifier that can safely be used in place of username
Unique identifier for the user, typically used in URLs
Name that can be safely used for display in HTML pages
URL location of the profile picture
Primary e-mail address to contact user
Primary phone number to contact user
Full name (effectively first name followed by last name)
Short casual name used to address the user
Preferred communication language
True if the user has valid login credentials
True if the user has valid login credentials
Date at which the user account was created
Date at which the user last logged in
Email verification code
Phone verification code
changes to the profile
{
"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
Site on which the product is hosted
Unique identifier shown in the URL bar
Name that can be safely used for display in HTML pages
URL location of the profile picture
One of 'organization', 'personal' or 'user'
True if the account has valid login credentials
Date/time of creation (in ISO format)
Full name
E-mail address
Phone number
Street address
City/Town
State/Province/County
Zip/Postal code
Country as 2-letter code (ISO 3166-1)
Timezone to use when reporting metrics
The profile can fulfill the provider side of a subscription.
Enable GroupBuy
Extra meta data (can be stringify JSON)
Describes the result of the action in human-readable form
Short casual name used to address the contact (only available for 'personal' and 'user' accounts)
Preferred communication language (only available for 'personal' and 'user' accounts)
Link back to the site
profile the notification relates to
Unique identifier shown in the URL bar
Name that can be safely used for display in HTML pages
URL location of the profile picture
One of 'organization', 'personal' or 'user'
True if the account has valid login credentials
Date/time of creation (in ISO format)
Full name
E-mail address
Phone number
Street address
City/Town
State/Province/County
Zip/Postal code
Country as 2-letter code (ISO 3166-1)
Timezone to use when reporting metrics
The profile can fulfill the provider side of a subscription.
Enable GroupBuy
Extra meta data (can be stringify JSON)
Describes the result of the action in human-readable form
Short casual name used to address the contact (only available for 'personal' and 'user' accounts)
Preferred communication language (only available for 'personal' and 'user' accounts)
the user at the origin of the notification
Unique identifier that can safely be used in place of username
Unique identifier for the user, typically used in URLs
Name that can be safely used for display in HTML pages
URL location of the profile picture
Primary e-mail address to contact user
Primary phone number to contact user
Full name (effectively first name followed by last name)
Short casual name used to address the user
Preferred communication language
True if the user has valid login credentials
True if the user has valid login credentials
Date at which the user account was created
Date at which the user last logged in
Email verification code
Phone verification code
provider when different from broker
Unique identifier shown in the URL bar
Name that can be safely used for display in HTML pages
URL location of the profile picture
One of 'organization', 'personal' or 'user'
True if the account has valid login credentials
Date/time of creation (in ISO format)
Full name
E-mail address
Phone number
Street address
City/Town
State/Province/County
Zip/Postal code
Country as 2-letter code (ISO 3166-1)
Timezone to use when reporting metrics
The profile can fulfill the provider side of a subscription.
Enable GroupBuy
Extra meta data (can be stringify JSON)
Describes the result of the action in human-readable form
Short casual name used to address the contact (only available for 'personal' and 'user' accounts)
Preferred communication language (only available for 'personal' and 'user' accounts)
the line items on the charge receipt
Date/time of creation (in ISO format)
Free-form text description for the transaction
Amount being transfered
True if the transaction is indentified as a debit in the API context
Source account from which funds are withdrawn
Billing profile from which funds are withdrawn
Unique identifier shown in the URL bar
Name that can be safely used for display in HTML pages
URL location of the profile picture
One of 'organization', 'personal' or 'user'
True if the account has valid login credentials
Date/time of creation (in ISO format)
Amount withdrawn from source in orig_unit
Three-letter ISO 4217 code for source currency unit (ex: usd)
Target account to which funds are deposited
Billing profile to which funds are deposited
Unique identifier shown in the URL bar
Name that can be safely used for display in HTML pages
URL location of the profile picture
One of 'organization', 'personal' or 'user'
True if the account has valid login credentials
Date/time of creation (in ISO format)
Amount deposited into target in dest_unit
Three-letter ISO 4217 code for target currency unit (ex: usd)
Total amount for the charge after refunds have been applied
amount in unit
Three-letter ISO 4217 code for currency unit (ex: usd)
the charge that relates to the notification
Date/time of creation (in ISO format)
Total amount in currency unit
Three-letter ISO 4217 code for currency unit (ex: usd)
Amount and unit in a commonly accepted readable format
Description for the charge as appears on billing statements
Last 4 digits of the credit card used
Expiration date of the credit card used
Unique identifier returned by the payment processor
Current state (i.e. created, done, failed, disputed)
Feedback for the user in plain text
{
"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
Site on which the product is hosted
Unique identifier shown in the URL bar
Name that can be safely used for display in HTML pages
URL location of the profile picture
One of 'organization', 'personal' or 'user'
True if the account has valid login credentials
Date/time of creation (in ISO format)
Full name
E-mail address
Phone number
Street address
City/Town
State/Province/County
Zip/Postal code
Country as 2-letter code (ISO 3166-1)
Timezone to use when reporting metrics
The profile can fulfill the provider side of a subscription.
Enable GroupBuy
Extra meta data (can be stringify JSON)
Describes the result of the action in human-readable form
Short casual name used to address the contact (only available for 'personal' and 'user' accounts)
Preferred communication language (only available for 'personal' and 'user' accounts)
Link back to the site
profile the notification relates to
Unique identifier shown in the URL bar
Name that can be safely used for display in HTML pages
URL location of the profile picture
One of 'organization', 'personal' or 'user'
True if the account has valid login credentials
Date/time of creation (in ISO format)
Full name
E-mail address
Phone number
Street address
City/Town
State/Province/County
Zip/Postal code
Country as 2-letter code (ISO 3166-1)
Timezone to use when reporting metrics
The profile can fulfill the provider side of a subscription.
Enable GroupBuy
Extra meta data (can be stringify JSON)
Describes the result of the action in human-readable form
Short casual name used to address the contact (only available for 'personal' and 'user' accounts)
Preferred communication language (only available for 'personal' and 'user' accounts)
the user at the origin of the notification
Unique identifier that can safely be used in place of username
Unique identifier for the user, typically used in URLs
Name that can be safely used for display in HTML pages
URL location of the profile picture
Primary e-mail address to contact user
Primary phone number to contact user
Full name (effectively first name followed by last name)
Short casual name used to address the user
Preferred communication language
True if the user has valid login credentials
True if the user has valid login credentials
Date at which the user account was created
Date at which the user last logged in
Email verification code
Phone verification code
provider when different from broker
Unique identifier shown in the URL bar
Name that can be safely used for display in HTML pages
URL location of the profile picture
One of 'organization', 'personal' or 'user'
True if the account has valid login credentials
Date/time of creation (in ISO format)
Full name
E-mail address
Phone number
Street address
City/Town
State/Province/County
Zip/Postal code
Country as 2-letter code (ISO 3166-1)
Timezone to use when reporting metrics
The profile can fulfill the provider side of a subscription.
Enable GroupBuy
Extra meta data (can be stringify JSON)
Describes the result of the action in human-readable form
Short casual name used to address the contact (only available for 'personal' and 'user' accounts)
Preferred communication language (only available for 'personal' and 'user' accounts)
Line items paid for already
Date/time of creation (in ISO format)
User the cart belongs to
Unique identifier that can safely be used in place of username
Unique identifier for the user, typically used in URLs
Name that can be safely used for display in HTML pages
URL location of the profile picture
Code used to assign the cart item to a user in group buy
Item in the cart (if plan)
Unique identifier shown in the URL bar
Title for the plan
Index in the list of discounts for advance payments
Item added to the cart (if use charge)
Number of periods to be paid in advance
identifier of the person that will benefit from the subscription (GroupBuy)
Full name of the person that will benefit from the subscription (GroupBuy)
e-mail of the person that will benefit from the subscription (GroupBuy)
Describes the result of the action in human-readable form
{
"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
Site on which the product is hosted
Unique identifier shown in the URL bar
Name that can be safely used for display in HTML pages
URL location of the profile picture
One of 'organization', 'personal' or 'user'
True if the account has valid login credentials
Date/time of creation (in ISO format)
Full name
E-mail address
Phone number
Street address
City/Town
State/Province/County
Zip/Postal code
Country as 2-letter code (ISO 3166-1)
Timezone to use when reporting metrics
The profile can fulfill the provider side of a subscription.
Enable GroupBuy
Extra meta data (can be stringify JSON)
Describes the result of the action in human-readable form
Short casual name used to address the contact (only available for 'personal' and 'user' accounts)
Preferred communication language (only available for 'personal' and 'user' accounts)
Link back to the site
profile the notification relates to
Unique identifier shown in the URL bar
Name that can be safely used for display in HTML pages
URL location of the profile picture
One of 'organization', 'personal' or 'user'
True if the account has valid login credentials
Date/time of creation (in ISO format)
Full name
E-mail address
Phone number
Street address
City/Town
State/Province/County
Zip/Postal code
Country as 2-letter code (ISO 3166-1)
Timezone to use when reporting metrics
The profile can fulfill the provider side of a subscription.
Enable GroupBuy
Extra meta data (can be stringify JSON)
Describes the result of the action in human-readable form
Short casual name used to address the contact (only available for 'personal' and 'user' accounts)
Preferred communication language (only available for 'personal' and 'user' accounts)
plan the subscription relates to
Unique identifier shown in the URL bar
Title for the plan
provider when different from broker
Unique identifier shown in the URL bar
Name that can be safely used for display in HTML pages
URL location of the profile picture
One of 'organization', 'personal' or 'user'
True if the account has valid login credentials
Date/time of creation (in ISO format)
Full name
E-mail address
Phone number
Street address
City/Town
State/Province/County
Zip/Postal code
Country as 2-letter code (ISO 3166-1)
Timezone to use when reporting metrics
The profile can fulfill the provider side of a subscription.
Enable GroupBuy
Extra meta data (can be stringify JSON)
Describes the result of the action in human-readable form
Short casual name used to address the contact (only available for 'personal' and 'user' accounts)
Preferred communication language (only available for 'personal' and 'user' accounts)
number of days before the subscription expires
{
"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
Site on which the product is hosted
Unique identifier shown in the URL bar
Name that can be safely used for display in HTML pages
URL location of the profile picture
One of 'organization', 'personal' or 'user'
True if the account has valid login credentials
Date/time of creation (in ISO format)
Full name
E-mail address
Phone number
Street address
City/Town
State/Province/County
Zip/Postal code
Country as 2-letter code (ISO 3166-1)
Timezone to use when reporting metrics
The profile can fulfill the provider side of a subscription.
Enable GroupBuy
Extra meta data (can be stringify JSON)
Describes the result of the action in human-readable form
Short casual name used to address the contact (only available for 'personal' and 'user' accounts)
Preferred communication language (only available for 'personal' and 'user' accounts)
Link back to the site
profile the notification relates to
Unique identifier shown in the URL bar
Name that can be safely used for display in HTML pages
URL location of the profile picture
One of 'organization', 'personal' or 'user'
True if the account has valid login credentials
Date/time of creation (in ISO format)
Full name
E-mail address
Phone number
Street address
City/Town
State/Province/County
Zip/Postal code
Country as 2-letter code (ISO 3166-1)
Timezone to use when reporting metrics
The profile can fulfill the provider side of a subscription.
Enable GroupBuy
Extra meta data (can be stringify JSON)
Describes the result of the action in human-readable form
Short casual name used to address the contact (only available for 'personal' and 'user' accounts)
Preferred communication language (only available for 'personal' and 'user' accounts)
the user at the origin of the notification
Unique identifier that can safely be used in place of username
Unique identifier for the user, typically used in URLs
Name that can be safely used for display in HTML pages
URL location of the profile picture
Primary e-mail address to contact user
Primary phone number to contact user
Full name (effectively first name followed by last name)
Short casual name used to address the user
Preferred communication language
True if the user has valid login credentials
True if the user has valid login credentials
Date at which the user account was created
Date at which the user last logged in
Email verification code
Phone verification code
provider when different from broker
Unique identifier shown in the URL bar
Name that can be safely used for display in HTML pages
URL location of the profile picture
One of 'organization', 'personal' or 'user'
True if the account has valid login credentials
Date/time of creation (in ISO format)
Full name
E-mail address
Phone number
Street address
City/Town
State/Province/County
Zip/Postal code
Country as 2-letter code (ISO 3166-1)
Timezone to use when reporting metrics
The profile can fulfill the provider side of a subscription.
Enable GroupBuy
Extra meta data (can be stringify JSON)
Describes the result of the action in human-readable form
Short casual name used to address the contact (only available for 'personal' and 'user' accounts)
Preferred communication language (only available for 'personal' and 'user' accounts)
Line items to charge on checkout
Date/time of creation (in ISO format)
Free-form text description for the transaction
Amount being transfered
True if the transaction is indentified as a debit in the API context
Source account from which funds are withdrawn
Billing profile from which funds are withdrawn
Unique identifier shown in the URL bar
Name that can be safely used for display in HTML pages
URL location of the profile picture
One of 'organization', 'personal' or 'user'
True if the account has valid login credentials
Date/time of creation (in ISO format)
Amount withdrawn from source in orig_unit
Three-letter ISO 4217 code for source currency unit (ex: usd)
Target account to which funds are deposited
Billing profile to which funds are deposited
Unique identifier shown in the URL bar
Name that can be safely used for display in HTML pages
URL location of the profile picture
One of 'organization', 'personal' or 'user'
True if the account has valid login credentials
Date/time of creation (in ISO format)
Amount deposited into target in dest_unit
Three-letter ISO 4217 code for target currency unit (ex: usd)
{
"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
Site on which the product is hosted
Unique identifier shown in the URL bar
Name that can be safely used for display in HTML pages
URL location of the profile picture
One of 'organization', 'personal' or 'user'
True if the account has valid login credentials
Date/time of creation (in ISO format)
Full name
E-mail address
Phone number
Street address
City/Town
State/Province/County
Zip/Postal code
Country as 2-letter code (ISO 3166-1)
Timezone to use when reporting metrics
The profile can fulfill the provider side of a subscription.
Enable GroupBuy
Extra meta data (can be stringify JSON)
Describes the result of the action in human-readable form
Short casual name used to address the contact (only available for 'personal' and 'user' accounts)
Preferred communication language (only available for 'personal' and 'user' accounts)
Link back to the site
profile the notification relates to
Unique identifier shown in the URL bar
Name that can be safely used for display in HTML pages
URL location of the profile picture
One of 'organization', 'personal' or 'user'
True if the account has valid login credentials
Date/time of creation (in ISO format)
Full name
E-mail address
Phone number
Street address
City/Town
State/Province/County
Zip/Postal code
Country as 2-letter code (ISO 3166-1)
Timezone to use when reporting metrics
The profile can fulfill the provider side of a subscription.
Enable GroupBuy
Extra meta data (can be stringify JSON)
Describes the result of the action in human-readable form
Short casual name used to address the contact (only available for 'personal' and 'user' accounts)
Preferred communication language (only available for 'personal' and 'user' accounts)
Date/time of creation (in ISO format)
{
"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
},
"table": [],
"date": "2024-01-07T00:00:00Z"
}Error with processor setup
The processor returned an error when a user attempted to pay for a cart.
Definition
Site on which the product is hosted
Unique identifier shown in the URL bar
Name that can be safely used for display in HTML pages
URL location of the profile picture
One of 'organization', 'personal' or 'user'
True if the account has valid login credentials
Date/time of creation (in ISO format)
Full name
E-mail address
Phone number
Street address
City/Town
State/Province/County
Zip/Postal code
Country as 2-letter code (ISO 3166-1)
Timezone to use when reporting metrics
The profile can fulfill the provider side of a subscription.
Enable GroupBuy
Extra meta data (can be stringify JSON)
Describes the result of the action in human-readable form
Short casual name used to address the contact (only available for 'personal' and 'user' accounts)
Preferred communication language (only available for 'personal' and 'user' accounts)
Link back to the site
profile the notification relates to
Unique identifier shown in the URL bar
Name that can be safely used for display in HTML pages
URL location of the profile picture
One of 'organization', 'personal' or 'user'
True if the account has valid login credentials
Date/time of creation (in ISO format)
Full name
E-mail address
Phone number
Street address
City/Town
State/Province/County
Zip/Postal code
Country as 2-letter code (ISO 3166-1)
Timezone to use when reporting metrics
The profile can fulfill the provider side of a subscription.
Enable GroupBuy
Extra meta data (can be stringify JSON)
Describes the result of the action in human-readable form
Short casual name used to address the contact (only available for 'personal' and 'user' accounts)
Preferred communication language (only available for 'personal' and 'user' accounts)
the user at the origin of the notification
Unique identifier that can safely be used in place of username
Unique identifier for the user, typically used in URLs
Name that can be safely used for display in HTML pages
URL location of the profile picture
Primary e-mail address to contact user
Primary phone number to contact user
Full name (effectively first name followed by last name)
Short casual name used to address the user
Preferred communication language
True if the user has valid login credentials
True if the user has valid login credentials
Date at which the user account was created
Date at which the user last logged in
Email verification code
Phone verification code
provider when different from broker
Unique identifier shown in the URL bar
Name that can be safely used for display in HTML pages
URL location of the profile picture
One of 'organization', 'personal' or 'user'
True if the account has valid login credentials
Date/time of creation (in ISO format)
Full name
E-mail address
Phone number
Street address
City/Town
State/Province/County
Zip/Postal code
Country as 2-letter code (ISO 3166-1)
Timezone to use when reporting metrics
The profile can fulfill the provider side of a subscription.
Enable GroupBuy
Extra meta data (can be stringify JSON)
Describes the result of the action in human-readable form
Short casual name used to address the contact (only available for 'personal' and 'user' accounts)
Preferred communication language (only available for 'personal' and 'user' accounts)
{
"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
Site on which the product is hosted
Unique identifier shown in the URL bar
Name that can be safely used for display in HTML pages
URL location of the profile picture
One of 'organization', 'personal' or 'user'
True if the account has valid login credentials
Date/time of creation (in ISO format)
Full name
E-mail address
Phone number
Street address
City/Town
State/Province/County
Zip/Postal code
Country as 2-letter code (ISO 3166-1)
Timezone to use when reporting metrics
The profile can fulfill the provider side of a subscription.
Enable GroupBuy
Extra meta data (can be stringify JSON)
Describes the result of the action in human-readable form
Short casual name used to address the contact (only available for 'personal' and 'user' accounts)
Preferred communication language (only available for 'personal' and 'user' accounts)
Link back to the site
profile the notification relates to
Unique identifier shown in the URL bar
Name that can be safely used for display in HTML pages
URL location of the profile picture
One of 'organization', 'personal' or 'user'
True if the account has valid login credentials
Date/time of creation (in ISO format)
Full name
E-mail address
Phone number
Street address
City/Town
State/Province/County
Zip/Postal code
Country as 2-letter code (ISO 3166-1)
Timezone to use when reporting metrics
The profile can fulfill the provider side of a subscription.
Enable GroupBuy
Extra meta data (can be stringify JSON)
Describes the result of the action in human-readable form
Short casual name used to address the contact (only available for 'personal' and 'user' accounts)
Preferred communication language (only available for 'personal' and 'user' accounts)
the user at the origin of the notification
Unique identifier that can safely be used in place of username
Unique identifier for the user, typically used in URLs
Name that can be safely used for display in HTML pages
URL location of the profile picture
Primary e-mail address to contact user
Primary phone number to contact user
Full name (effectively first name followed by last name)
Short casual name used to address the user
Preferred communication language
True if the user has valid login credentials
True if the user has valid login credentials
Date at which the user account was created
Date at which the user last logged in
Email verification code
Phone verification code
changes to the profile
{
"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"
}
}
}Renewal failed
This notification is sent when attempting to charge the credit card on file for renewal failed.
Definition
Site on which the product is hosted
Unique identifier shown in the URL bar
Name that can be safely used for display in HTML pages
URL location of the profile picture
One of 'organization', 'personal' or 'user'
True if the account has valid login credentials
Date/time of creation (in ISO format)
Full name
E-mail address
Phone number
Street address
City/Town
State/Province/County
Zip/Postal code
Country as 2-letter code (ISO 3166-1)
Timezone to use when reporting metrics
The profile can fulfill the provider side of a subscription.
Enable GroupBuy
Extra meta data (can be stringify JSON)
Describes the result of the action in human-readable form
Short casual name used to address the contact (only available for 'personal' and 'user' accounts)
Preferred communication language (only available for 'personal' and 'user' accounts)
Link back to the site
profile the notification relates to
Unique identifier shown in the URL bar
Name that can be safely used for display in HTML pages
URL location of the profile picture
One of 'organization', 'personal' or 'user'
True if the account has valid login credentials
Date/time of creation (in ISO format)
Full name
E-mail address
Phone number
Street address
City/Town
State/Province/County
Zip/Postal code
Country as 2-letter code (ISO 3166-1)
Timezone to use when reporting metrics
The profile can fulfill the provider side of a subscription.
Enable GroupBuy
Extra meta data (can be stringify JSON)
Describes the result of the action in human-readable form
Short casual name used to address the contact (only available for 'personal' and 'user' accounts)
Preferred communication language (only available for 'personal' and 'user' accounts)
provider when different from broker
Unique identifier shown in the URL bar
Name that can be safely used for display in HTML pages
URL location of the profile picture
One of 'organization', 'personal' or 'user'
True if the account has valid login credentials
Date/time of creation (in ISO format)
Full name
E-mail address
Phone number
Street address
City/Town
State/Province/County
Zip/Postal code
Country as 2-letter code (ISO 3166-1)
Timezone to use when reporting metrics
The profile can fulfill the provider side of a subscription.
Enable GroupBuy
Extra meta data (can be stringify JSON)
Describes the result of the action in human-readable form
Short casual name used to address the contact (only available for 'personal' and 'user' accounts)
Preferred communication language (only available for 'personal' and 'user' accounts)
Line items to charge for renewal
Date/time of creation (in ISO format)
Free-form text description for the transaction
Amount being transfered
True if the transaction is indentified as a debit in the API context
Source account from which funds are withdrawn
Billing profile from which funds are withdrawn
Unique identifier shown in the URL bar
Name that can be safely used for display in HTML pages
URL location of the profile picture
One of 'organization', 'personal' or 'user'
True if the account has valid login credentials
Date/time of creation (in ISO format)
Amount withdrawn from source in orig_unit
Three-letter ISO 4217 code for source currency unit (ex: usd)
Target account to which funds are deposited
Billing profile to which funds are deposited
Unique identifier shown in the URL bar
Name that can be safely used for display in HTML pages
URL location of the profile picture
One of 'organization', 'personal' or 'user'
True if the account has valid login credentials
Date/time of creation (in ISO format)
Amount deposited into target in dest_unit
Three-letter ISO 4217 code for target currency unit (ex: usd)
Total amount for the charge
amount in unit
Three-letter ISO 4217 code for currency unit (ex: usd)
number renewal attempts
maximimum number of renewal attempts
true if this is the final notice before subscription is canceled
{
"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
Site on which the product is hosted
Unique identifier shown in the URL bar
Name that can be safely used for display in HTML pages
URL location of the profile picture
One of 'organization', 'personal' or 'user'
True if the account has valid login credentials
Date/time of creation (in ISO format)
Full name
E-mail address
Phone number
Street address
City/Town
State/Province/County
Zip/Postal code
Country as 2-letter code (ISO 3166-1)
Timezone to use when reporting metrics
The profile can fulfill the provider side of a subscription.
Enable GroupBuy
Extra meta data (can be stringify JSON)
Describes the result of the action in human-readable form
Short casual name used to address the contact (only available for 'personal' and 'user' accounts)
Preferred communication language (only available for 'personal' and 'user' accounts)
Link back to the site
profile the notification relates to
Unique identifier shown in the URL bar
Name that can be safely used for display in HTML pages
URL location of the profile picture
One of 'organization', 'personal' or 'user'
True if the account has valid login credentials
Date/time of creation (in ISO format)
Full name
E-mail address
Phone number
Street address
City/Town
State/Province/County
Zip/Postal code
Country as 2-letter code (ISO 3166-1)
Timezone to use when reporting metrics
The profile can fulfill the provider side of a subscription.
Enable GroupBuy
Extra meta data (can be stringify JSON)
Describes the result of the action in human-readable form
Short casual name used to address the contact (only available for 'personal' and 'user' accounts)
Preferred communication language (only available for 'personal' and 'user' accounts)
the user at the origin of the notification
Unique identifier that can safely be used in place of username
Unique identifier for the user, typically used in URLs
Name that can be safely used for display in HTML pages
URL location of the profile picture
Primary e-mail address to contact user
Primary phone number to contact user
Full name (effectively first name followed by last name)
Short casual name used to address the user
Preferred communication language
True if the user has valid login credentials
True if the user has valid login credentials
Date at which the user account was created
Date at which the user last logged in
Email verification code
Phone verification code
user the notification applies to
Unique identifier that can safely be used in place of username
Unique identifier for the user, typically used in URLs
Name that can be safely used for display in HTML pages
URL location of the profile picture
Primary e-mail address to contact user
Primary phone number to contact user
Full name (effectively first name followed by last name)
Short casual name used to address the user
Preferred communication language
True if the user has valid login credentials
True if the user has valid login credentials
Date at which the user account was created
Date at which the user last logged in
Email verification code
Phone verification code
optional message at the attention of the user
description of the role the notification is about
Date/time of creation (in ISO format)
Unique identifier shown in the URL bar
Short description of the role. Grammatical rules to pluralize the title might be used in User Interfaces.
Automatically grants the role without requiring a user to accept it.
Automatically adds the role when a user and profile share the same e-mail domain.
Requires users with the role to sign-in using an OTP code as a multi-factor authentication.
True when the role type is available for all profiles
Profile the role type belongs to
Unique identifier shown in the URL bar
Name that can be safely used for display in HTML pages
URL location of the profile picture
One of 'organization', 'personal' or 'user'
True if the account has valid login credentials
Date/time of creation (in ISO format)
Extra meta data (can be stringify JSON)
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).
{
"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
Site on which the product is hosted
Unique identifier shown in the URL bar
Name that can be safely used for display in HTML pages
URL location of the profile picture
One of 'organization', 'personal' or 'user'
True if the account has valid login credentials
Date/time of creation (in ISO format)
Full name
E-mail address
Phone number
Street address
City/Town
State/Province/County
Zip/Postal code
Country as 2-letter code (ISO 3166-1)
Timezone to use when reporting metrics
The profile can fulfill the provider side of a subscription.
Enable GroupBuy
Extra meta data (can be stringify JSON)
Describes the result of the action in human-readable form
Short casual name used to address the contact (only available for 'personal' and 'user' accounts)
Preferred communication language (only available for 'personal' and 'user' accounts)
Link back to the site
profile the notification relates to
Unique identifier shown in the URL bar
Name that can be safely used for display in HTML pages
URL location of the profile picture
One of 'organization', 'personal' or 'user'
True if the account has valid login credentials
Date/time of creation (in ISO format)
Full name
E-mail address
Phone number
Street address
City/Town
State/Province/County
Zip/Postal code
Country as 2-letter code (ISO 3166-1)
Timezone to use when reporting metrics
The profile can fulfill the provider side of a subscription.
Enable GroupBuy
Extra meta data (can be stringify JSON)
Describes the result of the action in human-readable form
Short casual name used to address the contact (only available for 'personal' and 'user' accounts)
Preferred communication language (only available for 'personal' and 'user' accounts)
the user at the origin of the notification
Unique identifier that can safely be used in place of username
Unique identifier for the user, typically used in URLs
Name that can be safely used for display in HTML pages
URL location of the profile picture
Primary e-mail address to contact user
Primary phone number to contact user
Full name (effectively first name followed by last name)
Short casual name used to address the user
Preferred communication language
True if the user has valid login credentials
True if the user has valid login credentials
Date at which the user account was created
Date at which the user last logged in
Email verification code
Phone verification code
user the notification applies to
Unique identifier that can safely be used in place of username
Unique identifier for the user, typically used in URLs
Name that can be safely used for display in HTML pages
URL location of the profile picture
Primary e-mail address to contact user
Primary phone number to contact user
Full name (effectively first name followed by last name)
Short casual name used to address the user
Preferred communication language
True if the user has valid login credentials
True if the user has valid login credentials
Date at which the user account was created
Date at which the user last logged in
Email verification code
Phone verification code
optional message at the attention of the user
description of the role the notification is about
Date/time of creation (in ISO format)
Unique identifier shown in the URL bar
Short description of the role. Grammatical rules to pluralize the title might be used in User Interfaces.
Automatically grants the role without requiring a user to accept it.
Automatically adds the role when a user and profile share the same e-mail domain.
Requires users with the role to sign-in using an OTP code as a multi-factor authentication.
True when the role type is available for all profiles
Profile the role type belongs to
Unique identifier shown in the URL bar
Name that can be safely used for display in HTML pages
URL location of the profile picture
One of 'organization', 'personal' or 'user'
True if the account has valid login credentials
Date/time of creation (in ISO format)
Extra meta data (can be stringify JSON)
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).
{
"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
Site on which the product is hosted
Unique identifier shown in the URL bar
Name that can be safely used for display in HTML pages
URL location of the profile picture
One of 'organization', 'personal' or 'user'
True if the account has valid login credentials
Date/time of creation (in ISO format)
Full name
E-mail address
Phone number
Street address
City/Town
State/Province/County
Zip/Postal code
Country as 2-letter code (ISO 3166-1)
Timezone to use when reporting metrics
The profile can fulfill the provider side of a subscription.
Enable GroupBuy
Extra meta data (can be stringify JSON)
Describes the result of the action in human-readable form
Short casual name used to address the contact (only available for 'personal' and 'user' accounts)
Preferred communication language (only available for 'personal' and 'user' accounts)
Link back to the site
profile the notification relates to
Unique identifier shown in the URL bar
Name that can be safely used for display in HTML pages
URL location of the profile picture
One of 'organization', 'personal' or 'user'
True if the account has valid login credentials
Date/time of creation (in ISO format)
Full name
E-mail address
Phone number
Street address
City/Town
State/Province/County
Zip/Postal code
Country as 2-letter code (ISO 3166-1)
Timezone to use when reporting metrics
The profile can fulfill the provider side of a subscription.
Enable GroupBuy
Extra meta data (can be stringify JSON)
Describes the result of the action in human-readable form
Short casual name used to address the contact (only available for 'personal' and 'user' accounts)
Preferred communication language (only available for 'personal' and 'user' accounts)
the user at the origin of the notification
Unique identifier that can safely be used in place of username
Unique identifier for the user, typically used in URLs
Name that can be safely used for display in HTML pages
URL location of the profile picture
Primary e-mail address to contact user
Primary phone number to contact user
Full name (effectively first name followed by last name)
Short casual name used to address the user
Preferred communication language
True if the user has valid login credentials
True if the user has valid login credentials
Date at which the user account was created
Date at which the user last logged in
Email verification code
Phone verification code
user the notification applies to
Unique identifier that can safely be used in place of username
Unique identifier for the user, typically used in URLs
Name that can be safely used for display in HTML pages
URL location of the profile picture
Primary e-mail address to contact user
Primary phone number to contact user
Full name (effectively first name followed by last name)
Short casual name used to address the user
Preferred communication language
True if the user has valid login credentials
True if the user has valid login credentials
Date at which the user account was created
Date at which the user last logged in
Email verification code
Phone verification code
optional message at the attention of the user
{
"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
Site on which the product is hosted
Unique identifier shown in the URL bar
Name that can be safely used for display in HTML pages
URL location of the profile picture
One of 'organization', 'personal' or 'user'
True if the account has valid login credentials
Date/time of creation (in ISO format)
Full name
E-mail address
Phone number
Street address
City/Town
State/Province/County
Zip/Postal code
Country as 2-letter code (ISO 3166-1)
Timezone to use when reporting metrics
The profile can fulfill the provider side of a subscription.
Enable GroupBuy
Extra meta data (can be stringify JSON)
Describes the result of the action in human-readable form
Short casual name used to address the contact (only available for 'personal' and 'user' accounts)
Preferred communication language (only available for 'personal' and 'user' accounts)
Link back to the site
profile the notification relates to
Unique identifier shown in the URL bar
Name that can be safely used for display in HTML pages
URL location of the profile picture
One of 'organization', 'personal' or 'user'
True if the account has valid login credentials
Date/time of creation (in ISO format)
Full name
E-mail address
Phone number
Street address
City/Town
State/Province/County
Zip/Postal code
Country as 2-letter code (ISO 3166-1)
Timezone to use when reporting metrics
The profile can fulfill the provider side of a subscription.
Enable GroupBuy
Extra meta data (can be stringify JSON)
Describes the result of the action in human-readable form
Short casual name used to address the contact (only available for 'personal' and 'user' accounts)
Preferred communication language (only available for 'personal' and 'user' accounts)
the user at the origin of the notification
Unique identifier that can safely be used in place of username
Unique identifier for the user, typically used in URLs
Name that can be safely used for display in HTML pages
URL location of the profile picture
Primary e-mail address to contact user
Primary phone number to contact user
Full name (effectively first name followed by last name)
Short casual name used to address the user
Preferred communication language
True if the user has valid login credentials
True if the user has valid login credentials
Date at which the user account was created
Date at which the user last logged in
Email verification code
Phone verification code
provider when different from broker
Unique identifier shown in the URL bar
Name that can be safely used for display in HTML pages
URL location of the profile picture
One of 'organization', 'personal' or 'user'
True if the account has valid login credentials
Date/time of creation (in ISO format)
Full name
E-mail address
Phone number
Street address
City/Town
State/Province/County
Zip/Postal code
Country as 2-letter code (ISO 3166-1)
Timezone to use when reporting metrics
The profile can fulfill the provider side of a subscription.
Enable GroupBuy
Extra meta data (can be stringify JSON)
Describes the result of the action in human-readable form
Short casual name used to address the contact (only available for 'personal' and 'user' accounts)
Preferred communication language (only available for 'personal' and 'user' accounts)
plan the subscription relates to
Unique identifier shown in the URL bar
Title for the plan
{
"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
Site on which the product is hosted
Unique identifier shown in the URL bar
Name that can be safely used for display in HTML pages
URL location of the profile picture
One of 'organization', 'personal' or 'user'
True if the account has valid login credentials
Date/time of creation (in ISO format)
Full name
E-mail address
Phone number
Street address
City/Town
State/Province/County
Zip/Postal code
Country as 2-letter code (ISO 3166-1)
Timezone to use when reporting metrics
The profile can fulfill the provider side of a subscription.
Enable GroupBuy
Extra meta data (can be stringify JSON)
Describes the result of the action in human-readable form
Short casual name used to address the contact (only available for 'personal' and 'user' accounts)
Preferred communication language (only available for 'personal' and 'user' accounts)
Link back to the site
profile the notification relates to
Unique identifier shown in the URL bar
Name that can be safely used for display in HTML pages
URL location of the profile picture
One of 'organization', 'personal' or 'user'
True if the account has valid login credentials
Date/time of creation (in ISO format)
Full name
E-mail address
Phone number
Street address
City/Town
State/Province/County
Zip/Postal code
Country as 2-letter code (ISO 3166-1)
Timezone to use when reporting metrics
The profile can fulfill the provider side of a subscription.
Enable GroupBuy
Extra meta data (can be stringify JSON)
Describes the result of the action in human-readable form
Short casual name used to address the contact (only available for 'personal' and 'user' accounts)
Preferred communication language (only available for 'personal' and 'user' accounts)
the user at the origin of the notification
Unique identifier that can safely be used in place of username
Unique identifier for the user, typically used in URLs
Name that can be safely used for display in HTML pages
URL location of the profile picture
Primary e-mail address to contact user
Primary phone number to contact user
Full name (effectively first name followed by last name)
Short casual name used to address the user
Preferred communication language
True if the user has valid login credentials
True if the user has valid login credentials
Date at which the user account was created
Date at which the user last logged in
Email verification code
Phone verification code
provider when different from broker
Unique identifier shown in the URL bar
Name that can be safely used for display in HTML pages
URL location of the profile picture
One of 'organization', 'personal' or 'user'
True if the account has valid login credentials
Date/time of creation (in ISO format)
Full name
E-mail address
Phone number
Street address
City/Town
State/Province/County
Zip/Postal code
Country as 2-letter code (ISO 3166-1)
Timezone to use when reporting metrics
The profile can fulfill the provider side of a subscription.
Enable GroupBuy
Extra meta data (can be stringify JSON)
Describes the result of the action in human-readable form
Short casual name used to address the contact (only available for 'personal' and 'user' accounts)
Preferred communication language (only available for 'personal' and 'user' accounts)
plan the subscription relates to
Unique identifier shown in the URL bar
Title for the plan
optional message at the attention of the profile
{
"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
Site on which the product is hosted
Unique identifier shown in the URL bar
Name that can be safely used for display in HTML pages
URL location of the profile picture
One of 'organization', 'personal' or 'user'
True if the account has valid login credentials
Date/time of creation (in ISO format)
Full name
E-mail address
Phone number
Street address
City/Town
State/Province/County
Zip/Postal code
Country as 2-letter code (ISO 3166-1)
Timezone to use when reporting metrics
The profile can fulfill the provider side of a subscription.
Enable GroupBuy
Extra meta data (can be stringify JSON)
Describes the result of the action in human-readable form
Short casual name used to address the contact (only available for 'personal' and 'user' accounts)
Preferred communication language (only available for 'personal' and 'user' accounts)
Link back to the site
profile the notification relates to
Unique identifier shown in the URL bar
Name that can be safely used for display in HTML pages
URL location of the profile picture
One of 'organization', 'personal' or 'user'
True if the account has valid login credentials
Date/time of creation (in ISO format)
Full name
E-mail address
Phone number
Street address
City/Town
State/Province/County
Zip/Postal code
Country as 2-letter code (ISO 3166-1)
Timezone to use when reporting metrics
The profile can fulfill the provider side of a subscription.
Enable GroupBuy
Extra meta data (can be stringify JSON)
Describes the result of the action in human-readable form
Short casual name used to address the contact (only available for 'personal' and 'user' accounts)
Preferred communication language (only available for 'personal' and 'user' accounts)
the user at the origin of the notification
Unique identifier that can safely be used in place of username
Unique identifier for the user, typically used in URLs
Name that can be safely used for display in HTML pages
URL location of the profile picture
Primary e-mail address to contact user
Primary phone number to contact user
Full name (effectively first name followed by last name)
Short casual name used to address the user
Preferred communication language
True if the user has valid login credentials
True if the user has valid login credentials
Date at which the user account was created
Date at which the user last logged in
Email verification code
Phone verification code
provider when different from broker
Unique identifier shown in the URL bar
Name that can be safely used for display in HTML pages
URL location of the profile picture
One of 'organization', 'personal' or 'user'
True if the account has valid login credentials
Date/time of creation (in ISO format)
Full name
E-mail address
Phone number
Street address
City/Town
State/Province/County
Zip/Postal code
Country as 2-letter code (ISO 3166-1)
Timezone to use when reporting metrics
The profile can fulfill the provider side of a subscription.
Enable GroupBuy
Extra meta data (can be stringify JSON)
Describes the result of the action in human-readable form
Short casual name used to address the contact (only available for 'personal' and 'user' accounts)
Preferred communication language (only available for 'personal' and 'user' accounts)
plan the subscription relates to
Unique identifier shown in the URL bar
Title for the plan
{
"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
Site on which the product is hosted
Unique identifier shown in the URL bar
Name that can be safely used for display in HTML pages
URL location of the profile picture
One of 'organization', 'personal' or 'user'
True if the account has valid login credentials
Date/time of creation (in ISO format)
Full name
E-mail address
Phone number
Street address
City/Town
State/Province/County
Zip/Postal code
Country as 2-letter code (ISO 3166-1)
Timezone to use when reporting metrics
The profile can fulfill the provider side of a subscription.
Enable GroupBuy
Extra meta data (can be stringify JSON)
Describes the result of the action in human-readable form
Short casual name used to address the contact (only available for 'personal' and 'user' accounts)
Preferred communication language (only available for 'personal' and 'user' accounts)
Link back to the site
profile the notification relates to
Unique identifier shown in the URL bar
Name that can be safely used for display in HTML pages
URL location of the profile picture
One of 'organization', 'personal' or 'user'
True if the account has valid login credentials
Date/time of creation (in ISO format)
Full name
E-mail address
Phone number
Street address
City/Town
State/Province/County
Zip/Postal code
Country as 2-letter code (ISO 3166-1)
Timezone to use when reporting metrics
The profile can fulfill the provider side of a subscription.
Enable GroupBuy
Extra meta data (can be stringify JSON)
Describes the result of the action in human-readable form
Short casual name used to address the contact (only available for 'personal' and 'user' accounts)
Preferred communication language (only available for 'personal' and 'user' accounts)
the user at the origin of the notification
Unique identifier that can safely be used in place of username
Unique identifier for the user, typically used in URLs
Name that can be safely used for display in HTML pages
URL location of the profile picture
Primary e-mail address to contact user
Primary phone number to contact user
Full name (effectively first name followed by last name)
Short casual name used to address the user
Preferred communication language
True if the user has valid login credentials
True if the user has valid login credentials
Date at which the user account was created
Date at which the user last logged in
Email verification code
Phone verification code
provider when different from broker
Unique identifier shown in the URL bar
Name that can be safely used for display in HTML pages
URL location of the profile picture
One of 'organization', 'personal' or 'user'
True if the account has valid login credentials
Date/time of creation (in ISO format)
Full name
E-mail address
Phone number
Street address
City/Town
State/Province/County
Zip/Postal code
Country as 2-letter code (ISO 3166-1)
Timezone to use when reporting metrics
The profile can fulfill the provider side of a subscription.
Enable GroupBuy
Extra meta data (can be stringify JSON)
Describes the result of the action in human-readable form
Short casual name used to address the contact (only available for 'personal' and 'user' accounts)
Preferred communication language (only available for 'personal' and 'user' accounts)
plan the subscription relates to
Unique identifier shown in the URL bar
Title for the plan
optional message at the attention of the profile
{
"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"
}
}User activated
This notification is sent when a user has activated his/her account.
Definition
Site on which the product is hosted
Unique identifier shown in the URL bar
Name that can be safely used for display in HTML pages
URL location of the profile picture
One of 'organization', 'personal' or 'user'
True if the account has valid login credentials
Date/time of creation (in ISO format)
Full name
E-mail address
Phone number
Street address
City/Town
State/Province/County
Zip/Postal code
Country as 2-letter code (ISO 3166-1)
Timezone to use when reporting metrics
The profile can fulfill the provider side of a subscription.
Enable GroupBuy
Extra meta data (can be stringify JSON)
Describes the result of the action in human-readable form
Short casual name used to address the contact (only available for 'personal' and 'user' accounts)
Preferred communication language (only available for 'personal' and 'user' accounts)
Link back to the site
user the notification applies to
Unique identifier that can safely be used in place of username
Unique identifier for the user, typically used in URLs
Name that can be safely used for display in HTML pages
URL location of the profile picture
Primary e-mail address to contact user
Primary phone number to contact user
Full name (effectively first name followed by last name)
Short casual name used to address the user
Preferred communication language
True if the user has valid login credentials
True if the user has valid login credentials
Date at which the user account was created
Date at which the user last logged in
Email verification code
Phone verification code
{
"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
Site on which the product is hosted
Unique identifier shown in the URL bar
Name that can be safely used for display in HTML pages
URL location of the profile picture
One of 'organization', 'personal' or 'user'
True if the account has valid login credentials
Date/time of creation (in ISO format)
Full name
E-mail address
Phone number
Street address
City/Town
State/Province/County
Zip/Postal code
Country as 2-letter code (ISO 3166-1)
Timezone to use when reporting metrics
The profile can fulfill the provider side of a subscription.
Enable GroupBuy
Extra meta data (can be stringify JSON)
Describes the result of the action in human-readable form
Short casual name used to address the contact (only available for 'personal' and 'user' accounts)
Preferred communication language (only available for 'personal' and 'user' accounts)
Link back to the site
the user at the origin of the notification
Unique identifier that can safely be used in place of username
Unique identifier for the user, typically used in URLs
Name that can be safely used for display in HTML pages
URL location of the profile picture
Primary e-mail address to contact user
Primary phone number to contact user
Full name (effectively first name followed by last name)
Short casual name used to address the user
Preferred communication language
True if the user has valid login credentials
True if the user has valid login credentials
Date at which the user account was created
Date at which the user last logged in
Email verification code
Phone verification code
provider when different from broker
Unique identifier shown in the URL bar
Name that can be safely used for display in HTML pages
URL location of the profile picture
One of 'organization', 'personal' or 'user'
True if the account has valid login credentials
Date/time of creation (in ISO format)
Full name
E-mail address
Phone number
Street address
City/Town
State/Province/County
Zip/Postal code
Country as 2-letter code (ISO 3166-1)
Timezone to use when reporting metrics
The profile can fulfill the provider side of a subscription.
Enable GroupBuy
Extra meta data (can be stringify JSON)
Describes the result of the action in human-readable form
Short casual name used to address the contact (only available for 'personal' and 'user' accounts)
Preferred communication language (only available for 'personal' and 'user' accounts)
information passed in the 'Contact us' form, including message
{
"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
Site on which the product is hosted
Unique identifier shown in the URL bar
Name that can be safely used for display in HTML pages
URL location of the profile picture
One of 'organization', 'personal' or 'user'
True if the account has valid login credentials
Date/time of creation (in ISO format)
Full name
E-mail address
Phone number
Street address
City/Town
State/Province/County
Zip/Postal code
Country as 2-letter code (ISO 3166-1)
Timezone to use when reporting metrics
The profile can fulfill the provider side of a subscription.
Enable GroupBuy
Extra meta data (can be stringify JSON)
Describes the result of the action in human-readable form
Short casual name used to address the contact (only available for 'personal' and 'user' accounts)
Preferred communication language (only available for 'personal' and 'user' accounts)
Link back to the site
user the notification applies to
Unique identifier that can safely be used in place of username
Unique identifier for the user, typically used in URLs
Name that can be safely used for display in HTML pages
URL location of the profile picture
Primary e-mail address to contact user
Primary phone number to contact user
Full name (effectively first name followed by last name)
Short casual name used to address the user
Preferred communication language
True if the user has valid login credentials
True if the user has valid login credentials
Date at which the user account was created
Date at which the user last logged in
Email verification code
Phone verification code
{
"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
Site on which the product is hosted
Unique identifier shown in the URL bar
Name that can be safely used for display in HTML pages
URL location of the profile picture
One of 'organization', 'personal' or 'user'
True if the account has valid login credentials
Date/time of creation (in ISO format)
Full name
E-mail address
Phone number
Street address
City/Town
State/Province/County
Zip/Postal code
Country as 2-letter code (ISO 3166-1)
Timezone to use when reporting metrics
The profile can fulfill the provider side of a subscription.
Enable GroupBuy
Extra meta data (can be stringify JSON)
Describes the result of the action in human-readable form
Short casual name used to address the contact (only available for 'personal' and 'user' accounts)
Preferred communication language (only available for 'personal' and 'user' accounts)
Link back to the site
user the notification applies to
Unique identifier that can safely be used in place of username
Unique identifier for the user, typically used in URLs
Name that can be safely used for display in HTML pages
URL location of the profile picture
Primary e-mail address to contact user
Primary phone number to contact user
Full name (effectively first name followed by last name)
Short casual name used to address the user
Preferred communication language
True if the user has valid login credentials
True if the user has valid login credentials
Date at which the user account was created
Date at which the user last logged in
Email verification code
Phone verification code
{
"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
Site on which the product is hosted
Unique identifier shown in the URL bar
Name that can be safely used for display in HTML pages
URL location of the profile picture
One of 'organization', 'personal' or 'user'
True if the account has valid login credentials
Date/time of creation (in ISO format)
Full name
E-mail address
Phone number
Street address
City/Town
State/Province/County
Zip/Postal code
Country as 2-letter code (ISO 3166-1)
Timezone to use when reporting metrics
The profile can fulfill the provider side of a subscription.
Enable GroupBuy
Extra meta data (can be stringify JSON)
Describes the result of the action in human-readable form
Short casual name used to address the contact (only available for 'personal' and 'user' accounts)
Preferred communication language (only available for 'personal' and 'user' accounts)
Link back to the site
user the notification applies to
Unique identifier that can safely be used in place of username
Unique identifier for the user, typically used in URLs
Name that can be safely used for display in HTML pages
URL location of the profile picture
Primary e-mail address to contact user
Primary phone number to contact user
Full name (effectively first name followed by last name)
Short casual name used to address the user
Preferred communication language
True if the user has valid login credentials
True if the user has valid login credentials
Date at which the user account was created
Date at which the user last logged in
Email verification code
Phone verification code
{
"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
}
}