Webhooks and events
Every event Allpage sends, with its payload. 89 events.
Each event is POSTed as JSON with id, type, occurredAt, businessId, subject and data, signed per Standard Webhooks. Receive events with webhooks covers adding an address and checking the signature. Standard events go to every endpoint that doesn't pick its own; the rest only where they're picked. An app gets an event only when its grant sees the area (the scope below).
| Event | What | Standard | Scope | Version |
|---|---|---|---|---|
api.tokenCreated | You made an API token | No | api:read | 1 |
api.tokenRevoked | You revoked an API token | No | api:read | 1 |
apps.connected | You connected an app | No | apps:read | 1 |
apps.disconnected | You disconnected an app | No | apps:read | 1 |
assistant.autonomyChanged | You changed what the assistant may do without asking | No | assistant:read | 1 |
assistant.improveChanged | You changed whether your AI conversations help improve Allpage | No | assistant:read | 1 |
automation.owner_notified | An automation sent you a note | No | playbook:read | 1 |
billing.changed | Your plan or its status changed | No | billing:read | 1 |
business.closed | The business closed | No | business:read | 1 |
business.created | A business was started | No | business:read | 1 |
business.opened | A business opened | No | business:read | 1 |
business.renamed | The business changed its web address | No | business:read | 1 |
channels.changed | The assistant’s text, WhatsApp, email, Instagram or Messenger changed | No | channels:read | 1 |
commerce.agreement_accepted | A customer accepted a sale | Yes | commerce:read | 1 |
commerce.agreement_ended | A sale was cancelled or ran out | Yes | commerce:read | 2 |
commerce.agreement_offered | An offer was sent to a customer | Yes | commerce:read | 1 |
commerce.agreement_started | A sale started | Yes | commerce:read | 1 |
commerce.charge_paid | A charge was paid | Yes | commerce:read | 2 |
commerce.charge_refunded | A charge was refunded | Yes | commerce:read | 1 |
commerce.downloaded | A customer downloaded a file they bought | No | commerce:read | 1 |
commerce.inventory_changed | A product’s stock count changed | Yes | commerce:read | 1 |
commerce.order_changed | An order was placed, sent, delivered or cancelled | Yes | commerce:read | 1 |
commerce.price_published | A price was set | Yes | commerce:read | 1 |
commerce.product_archived | A product was taken off sale | Yes | commerce:read | 1 |
commerce.product_created | A product was added | Yes | commerce:read | 1 |
commerce.product_restored | A product was put back on sale | Yes | commerce:read | 1 |
commerce.product_updated | A product was changed | Yes | commerce:read | 1 |
commerce.quote_requested | A customer asked for a quote | Yes | commerce:read | 1 |
commerce.stored_value_changed | A gift card or store credit balance changed | Yes | commerce:read | 1 |
conversation.received | A message came in | Yes | inbox:read | 1 |
conversation.replied | A reply went out in a conversation | No | 1 | |
conversion.recorded | A visit turned into a booking, form, order or signup | No | 1 | |
customer.added | A new customer was added to your list | Yes | customers:read | 1 |
customer.dependent_added | A customer added someone they book for | Yes | customers:read | 1 |
customer.dependent_removed | A customer removed someone they book for | Yes | customers:read | 1 |
customer.forgotten | A customer was removed | Yes | customers:read | 1 |
customer.joined | A customer made an account with you | Yes | customers:read | 1 |
customer.merged | Two customers were merged | Yes | customers:read | 1 |
domain.added | You added a domain | No | domains:read | 1 |
domain.email_added | You started sending email from your domain | No | domains:read | 1 |
domain.email_removed | You stopped sending email from your domain | No | domains:read | 1 |
domain.email_verified | Your emails come from your domain | No | domains:read | 1 |
domain.removed | You removed a domain | No | domains:read | 1 |
domain.verified | Your domain is connected | No | domains:read | 1 |
form.submitted | A form was sent in | Yes | customers:read | 1 |
formation.formed | The LLC was formed | Yes | formation:read | 1 |
formation.ordered | An LLC was ordered | Yes | formation:read | 1 |
formation.rejected | An LLC order was turned down | Yes | formation:read | 1 |
grant.cancelled | A pack or membership was cancelled | No | grants:read | 1 |
integration.connected | An outside service was connected or given more access | No | 1 | |
integration.disconnected | An outside service was disconnected | No | 1 | |
integration.needs_reconnect | A connected service stopped working and needs reconnecting | No | 1 | |
integration.received | Something a connected service read is waiting to be filed | No | 1 | |
integration.shipment_updated | A shipping service said where a package is now | No | 1 | |
listing.review_replied | A reply to a Google review was posted, failed or is waiting | No | listings:read | 1 |
location.saved | A location was added or changed | No | business:read | 1 |
loyalty.reward_earned | A customer earned a reward | Yes | loyalty:read | 1 |
message.failed | A message to a customer failed | No | 1 | |
message.sent | A message to a customer went out | No | 1 | |
message.skipped | A message to a customer wasn’t sent | No | 1 | |
message.unknown | A message to a customer may not have gone out | No | 1 | |
module.active | A tool turned on | No | 1 | |
module.off | A tool turned off | No | 1 | |
module.winding_down | A tool is winding down: it keeps its commitments and takes nothing new | No | 1 | |
offering.archived | An offering was archived | No | offerings:read | 1 |
offering.attended | Someone came to a session | No | offerings:read | 1 |
offering.cancelled | A booking was cancelled | Yes | offerings:read | 1 |
offering.enrolled | Someone booked a place | Yes | offerings:read | 1 |
offering.no_show | Someone didn’t show for a session | No | offerings:read | 1 |
offering.saved | An offering was set up or changed | No | offerings:read | 1 |
offering.session_called_off | A session was called off | Yes | offerings:read | 1 |
offering.session_changed | A session changed | Yes | offerings:read | 1 |
offering.transferred | A booking moved or changed hands | Yes | offerings:read | 1 |
offering.waitlisted | Someone joined a waitlist | Yes | offerings:read | 1 |
payments.account_changed | Your payments account changed status | No | payments:read | 1 |
playbook.disabled | You turned off an automation | No | 1 | |
playbook.enabled | You turned on an automation | No | 1 | |
policy.accepted | You accepted a policy | No | 1 | |
record.checked | Your address was checked | No | 1 | |
record.updated | Your business details changed | No | business:read | 1 |
requirement.met | A form was signed or a record sent for a booking | No | forms:read | 1 |
review.received | A review came in | Yes | reviews:read | 1 |
review.requested | A customer was asked for a review | No | reviews:read | 1 |
site.published | The website was published | Yes | site:read | 1 |
suggestion.requested | An automation needs you: a policy to accept, or a new version to review | No | 1 | |
texting.approved | Texting is approved for your business | No | messaging:read | 1 |
texting.rejected | The carriers turned down your texting registration | No | messaging:read | 1 |
workflow.disabled | You turned off an automation you built | No | 1 | |
workflow.published | You published an automation you built | No | 1 |
api.tokenCreated
You made an API token
- Standard
- Only when picked
- Scope
api:read- Version
- 1
data
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"name": {
"type": "string"
},
"prefix": {
"type": "string"
}
},
"required": [
"name",
"prefix"
],
"additionalProperties": false
}api.tokenRevoked
You revoked an API token
- Standard
- Only when picked
- Scope
api:read- Version
- 1
data
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"name": {
"type": "string"
}
},
"required": [
"name"
],
"additionalProperties": false
}apps.connected
You connected an app
- Standard
- Only when picked
- Scope
apps:read- Version
- 1
data
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"clientName": {
"type": "string"
}
},
"required": [
"clientName"
],
"additionalProperties": false
}apps.disconnected
You disconnected an app
- Standard
- Only when picked
- Scope
apps:read- Version
- 1
data
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"clientName": {
"type": "string"
}
},
"required": [
"clientName"
],
"additionalProperties": false
}assistant.autonomyChanged
You changed what the assistant may do without asking
- Standard
- Only when picked
- Scope
assistant:read- Version
- 1
data
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"version": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"settings": {
"type": "object",
"properties": {
"assistant": {
"default": {},
"type": "object",
"propertyNames": {
"type": "string",
"maxLength": 60
},
"additionalProperties": {
"type": "string",
"enum": [
"auto",
"ask",
"never"
]
}
},
"agent": {
"default": {},
"type": "object",
"propertyNames": {
"type": "string",
"maxLength": 60
},
"additionalProperties": {
"type": "string",
"enum": [
"auto",
"ask",
"never"
]
}
},
"apps": {
"default": {},
"type": "object",
"propertyNames": {
"type": "string",
"maxLength": 200
},
"additionalProperties": {
"type": "object",
"propertyNames": {
"type": "string",
"maxLength": 60
},
"additionalProperties": {
"type": "string",
"enum": [
"auto",
"ask",
"never"
]
}
}
},
"channels": {
"type": "object",
"propertyNames": {
"type": "string",
"enum": [
"sms",
"whatsapp",
"email",
"instagram",
"messenger"
]
},
"additionalProperties": {
"type": "object",
"propertyNames": {
"type": "string",
"maxLength": 60
},
"additionalProperties": {
"type": "string",
"enum": [
"auto",
"ask",
"never"
]
}
}
}
},
"required": [
"assistant",
"agent",
"apps"
],
"additionalProperties": false
}
},
"required": [
"version",
"settings"
],
"additionalProperties": false
}assistant.improveChanged
You changed whether your AI conversations help improve Allpage
- Standard
- Only when picked
- Scope
assistant:read- Version
- 1
data
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"improve": {
"type": "boolean"
}
},
"required": [
"improve"
],
"additionalProperties": false
}automation.owner_notified
An automation sent you a note
- Standard
- Only when picked
- Scope
playbook:read- Version
- 1
data
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"notificationId": {
"type": "string",
"pattern": "^ntf_[0-9a-hjkmnp-tv-z]{26}$",
"description": "A notification id: ntf_ and 26 letters and digits."
},
"customerId": {
"type": "string",
"pattern": "^cus_[0-9a-hjkmnp-tv-z]{26}$",
"description": "A customer id: cus_ and 26 letters and digits."
}
},
"required": [
"notificationId"
],
"additionalProperties": false
}billing.changed
Your plan or its status changed
- Standard
- Only when picked
- Scope
billing:read- Version
- 1
data
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"status": {
"type": "string"
},
"plan": {
"type": "string"
},
"from": {
"type": "string",
"description": "The status before, or `none`."
}
},
"required": [
"status",
"plan",
"from"
],
"additionalProperties": false
}business.closed
The business closed
- Standard
- Only when picked
- Scope
business:read- Version
- 1
data
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"closedAt": {
"type": "string",
"description": "When it closed, ISO 8601"
},
"paymentsUntil": {
"type": "string",
"description": "Payments stay connected until then, for refunds and disputes"
}
},
"required": [
"closedAt",
"paymentsUntil"
],
"additionalProperties": false
}business.created
A business was started
- Standard
- Only when picked
- Scope
business:read- Version
- 1
data
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"businessId": {
"type": "string",
"description": "The new business"
},
"name": {
"type": "string"
}
},
"required": [
"businessId",
"name"
],
"additionalProperties": false
}business.opened
A business opened
- Standard
- Only when picked
- Scope
business:read- Version
- 1
data
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"businessId": {
"type": "string",
"description": "The business that opened"
},
"kind": {
"type": "string",
"description": "The kind of business it opened as"
}
},
"required": [
"businessId",
"kind"
],
"additionalProperties": false
}business.renamed
The business changed its web address
- Standard
- Only when picked
- Scope
business:read- Version
- 1
data
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"handle": {
"type": "string",
"description": "Its new handle: <handle>.allpage.site"
},
"previous": {
"type": "string",
"description": "The handle it left, which redirects for 12 months"
}
},
"required": [
"handle",
"previous"
],
"additionalProperties": false
}channels.changed
The assistant’s text, WhatsApp, email, Instagram or Messenger changed
- Standard
- Only when picked
- Scope
channels:read- Version
- 1
data
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"channel": {
"type": "string",
"enum": [
"sms",
"whatsapp",
"email",
"instagram",
"messenger"
]
},
"status": {
"type": "string",
"enum": [
"pending",
"active",
"off"
]
}
},
"required": [
"channel",
"status"
],
"additionalProperties": false
}commerce.agreement_accepted
A customer accepted a sale
- Standard
- Yes
- Scope
commerce:read- Version
- 1
data
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"agreementId": {
"type": "string",
"pattern": "^agr_[0-9a-hjkmnp-tv-z]{26}$",
"description": "A agreement id: agr_ and 26 letters and digits."
},
"customerId": {
"type": "string",
"pattern": "^cus_[0-9a-hjkmnp-tv-z]{26}$",
"description": "A customer id: cus_ and 26 letters and digits."
},
"status": {
"type": "string",
"enum": [
"draft",
"offered",
"accepted",
"active",
"past_due",
"paused",
"active_unpaid",
"cancel_scheduled",
"cancelled",
"fulfilled",
"expired",
"abandoned"
]
},
"totalMinor": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"currency": {
"type": "string"
},
"repeats": {
"type": "boolean"
}
},
"required": [
"agreementId",
"customerId",
"status",
"totalMinor",
"currency",
"repeats"
],
"additionalProperties": false
}commerce.agreement_ended
A sale was cancelled or ran out
- Standard
- Yes
- Scope
commerce:read- Version
- 2
data
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"agreementId": {
"type": "string",
"pattern": "^agr_[0-9a-hjkmnp-tv-z]{26}$",
"description": "A agreement id: agr_ and 26 letters and digits."
},
"customerId": {
"type": "string",
"pattern": "^cus_[0-9a-hjkmnp-tv-z]{26}$",
"description": "A customer id: cus_ and 26 letters and digits."
},
"status": {
"type": "string",
"enum": [
"draft",
"offered",
"accepted",
"active",
"past_due",
"paused",
"active_unpaid",
"cancel_scheduled",
"cancelled",
"fulfilled",
"expired",
"abandoned"
]
},
"totalMinor": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"currency": {
"type": "string"
},
"repeats": {
"type": "boolean"
},
"cause": {
"type": "string",
"enum": [
"expired",
"abandoned",
"taken",
"cancelled"
]
}
},
"required": [
"agreementId",
"customerId",
"status",
"totalMinor",
"currency",
"repeats",
"cause"
],
"additionalProperties": false
}commerce.agreement_offered
An offer was sent to a customer
- Standard
- Yes
- Scope
commerce:read- Version
- 1
data
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"agreementId": {
"type": "string",
"pattern": "^agr_[0-9a-hjkmnp-tv-z]{26}$",
"description": "A agreement id: agr_ and 26 letters and digits."
},
"customerId": {
"type": "string",
"pattern": "^cus_[0-9a-hjkmnp-tv-z]{26}$",
"description": "A customer id: cus_ and 26 letters and digits."
},
"status": {
"type": "string",
"enum": [
"draft",
"offered",
"accepted",
"active",
"past_due",
"paused",
"active_unpaid",
"cancel_scheduled",
"cancelled",
"fulfilled",
"expired",
"abandoned"
]
},
"totalMinor": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"currency": {
"type": "string"
},
"repeats": {
"type": "boolean"
}
},
"required": [
"agreementId",
"customerId",
"status",
"totalMinor",
"currency",
"repeats"
],
"additionalProperties": false
}commerce.agreement_started
A sale started
- Standard
- Yes
- Scope
commerce:read- Version
- 1
data
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"agreementId": {
"type": "string",
"pattern": "^agr_[0-9a-hjkmnp-tv-z]{26}$",
"description": "A agreement id: agr_ and 26 letters and digits."
},
"customerId": {
"type": "string",
"pattern": "^cus_[0-9a-hjkmnp-tv-z]{26}$",
"description": "A customer id: cus_ and 26 letters and digits."
},
"status": {
"type": "string",
"enum": [
"draft",
"offered",
"accepted",
"active",
"past_due",
"paused",
"active_unpaid",
"cancel_scheduled",
"cancelled",
"fulfilled",
"expired",
"abandoned"
]
},
"totalMinor": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"currency": {
"type": "string"
},
"repeats": {
"type": "boolean"
}
},
"required": [
"agreementId",
"customerId",
"status",
"totalMinor",
"currency",
"repeats"
],
"additionalProperties": false
}commerce.charge_paid
A charge was paid
- Standard
- Yes
- Scope
commerce:read- Version
- 2
data
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"chargeId": {
"type": "string",
"pattern": "^chg_[0-9a-hjkmnp-tv-z]{26}$",
"description": "A charge id: chg_ and 26 letters and digits."
},
"agreementId": {
"type": "string",
"pattern": "^agr_[0-9a-hjkmnp-tv-z]{26}$",
"description": "A agreement id: agr_ and 26 letters and digits."
},
"customerId": {
"type": "string",
"pattern": "^cus_[0-9a-hjkmnp-tv-z]{26}$",
"description": "A customer id: cus_ and 26 letters and digits."
},
"step": {
"type": "string"
},
"amountMinor": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"currency": {
"type": "string"
}
},
"required": [
"chargeId",
"agreementId",
"customerId",
"step",
"amountMinor",
"currency"
],
"additionalProperties": false
}commerce.charge_refunded
A charge was refunded
- Standard
- Yes
- Scope
commerce:read- Version
- 1
data
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"chargeId": {
"type": "string",
"pattern": "^chg_[0-9a-hjkmnp-tv-z]{26}$",
"description": "A charge id: chg_ and 26 letters and digits."
},
"agreementId": {
"type": "string",
"pattern": "^agr_[0-9a-hjkmnp-tv-z]{26}$",
"description": "A agreement id: agr_ and 26 letters and digits."
},
"customerId": {
"type": "string",
"pattern": "^cus_[0-9a-hjkmnp-tv-z]{26}$",
"description": "A customer id: cus_ and 26 letters and digits."
},
"amountMinor": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"currency": {
"type": "string"
},
"full": {
"type": "boolean"
}
},
"required": [
"chargeId",
"agreementId",
"customerId",
"amountMinor",
"currency",
"full"
],
"additionalProperties": false
}commerce.downloaded
A customer downloaded a file they bought
- Standard
- Only when picked
- Scope
commerce:read- Version
- 1
data
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"customerId": {
"type": "string",
"pattern": "^cus_[0-9a-hjkmnp-tv-z]{26}$",
"description": "A customer id: cus_ and 26 letters and digits."
},
"agreementId": {
"type": "string",
"pattern": "^agr_[0-9a-hjkmnp-tv-z]{26}$",
"description": "A agreement id: agr_ and 26 letters and digits."
},
"lineId": {
"type": "string",
"pattern": "^ln_[0-9a-hjkmnp-tv-z]{26}$",
"description": "A line id: ln_ and 26 letters and digits."
},
"fileId": {
"type": "string",
"pattern": "^fil_[0-9a-hjkmnp-tv-z]{26}$",
"description": "A file id: fil_ and 26 letters and digits."
},
"name": {
"type": "string"
}
},
"required": [
"customerId",
"agreementId",
"lineId",
"fileId",
"name"
],
"additionalProperties": false
}commerce.inventory_changed
A product’s stock count changed
- Standard
- Yes
- Scope
commerce:read- Version
- 1
data
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"productId": {
"type": "string",
"pattern": "^prd_[0-9a-hjkmnp-tv-z]{26}$",
"description": "A product id: prd_ and 26 letters and digits."
},
"variantId": {
"anyOf": [
{
"type": "string",
"pattern": "^var_[0-9a-hjkmnp-tv-z]{26}$",
"description": "A variant id: var_ and 26 letters and digits."
},
{
"type": "null"
}
]
},
"count": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"reason": {
"type": "string",
"enum": [
"set",
"held",
"returned"
]
}
},
"required": [
"productId",
"variantId",
"count",
"reason"
],
"additionalProperties": false
}commerce.order_changed
An order was placed, sent, delivered or cancelled
- Standard
- Yes
- Scope
commerce:read- Version
- 1
data
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"orderId": {
"type": "string",
"pattern": "^ord_[0-9a-hjkmnp-tv-z]{26}$",
"description": "A order id: ord_ and 26 letters and digits."
},
"agreementId": {
"type": "string",
"pattern": "^agr_[0-9a-hjkmnp-tv-z]{26}$",
"description": "A agreement id: agr_ and 26 letters and digits."
},
"customerId": {
"type": "string",
"pattern": "^cus_[0-9a-hjkmnp-tv-z]{26}$",
"description": "A customer id: cus_ and 26 letters and digits."
},
"number": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"method": {
"type": "string",
"enum": [
"ship",
"local_delivery",
"pickup"
]
},
"status": {
"type": "string",
"enum": [
"unfulfilled",
"packed",
"shipped",
"delivered",
"picked_up",
"cancelled"
]
},
"carrier": {
"anyOf": [
{
"type": "string",
"enum": [
"usps",
"ups",
"fedex",
"dhl",
"other"
]
},
{
"type": "null"
}
]
},
"trackingNumber": {
"type": [
"string",
"null"
]
}
},
"required": [
"orderId",
"agreementId",
"customerId",
"number",
"method",
"status",
"carrier",
"trackingNumber"
],
"additionalProperties": false
}commerce.price_published
A price was set
- Standard
- Yes
- Scope
commerce:read- Version
- 1
data
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"productId": {
"type": "string",
"pattern": "^prd_[0-9a-hjkmnp-tv-z]{26}$",
"description": "A product id: prd_ and 26 letters and digits."
},
"priceId": {
"type": "string",
"pattern": "^pri_[0-9a-hjkmnp-tv-z]{26}$",
"description": "A price id: pri_ and 26 letters and digits."
},
"versionId": {
"type": "string",
"pattern": "^prv_[0-9a-hjkmnp-tv-z]{26}$",
"description": "A price version id: prv_ and 26 letters and digits."
},
"version": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"model": {
"type": "string",
"enum": [
"flat",
"per_unit",
"tiered",
"deposit",
"pay_what_you_want",
"quote_required"
]
}
},
"required": [
"productId",
"priceId",
"versionId",
"version",
"model"
],
"additionalProperties": false
}commerce.product_archived
A product was taken off sale
- Standard
- Yes
- Scope
commerce:read- Version
- 1
data
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"productId": {
"type": "string",
"pattern": "^prd_[0-9a-hjkmnp-tv-z]{26}$",
"description": "A product id: prd_ and 26 letters and digits."
},
"name": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"service",
"physical",
"digital",
"access",
"bundle",
"gift_card",
"shipping"
]
}
},
"required": [
"productId",
"name",
"type"
],
"additionalProperties": false
}commerce.product_created
A product was added
- Standard
- Yes
- Scope
commerce:read- Version
- 1
data
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"productId": {
"type": "string",
"pattern": "^prd_[0-9a-hjkmnp-tv-z]{26}$",
"description": "A product id: prd_ and 26 letters and digits."
},
"name": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"service",
"physical",
"digital",
"access",
"bundle",
"gift_card",
"shipping"
]
}
},
"required": [
"productId",
"name",
"type"
],
"additionalProperties": false
}commerce.product_restored
A product was put back on sale
- Standard
- Yes
- Scope
commerce:read- Version
- 1
data
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"productId": {
"type": "string",
"pattern": "^prd_[0-9a-hjkmnp-tv-z]{26}$",
"description": "A product id: prd_ and 26 letters and digits."
},
"name": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"service",
"physical",
"digital",
"access",
"bundle",
"gift_card",
"shipping"
]
}
},
"required": [
"productId",
"name",
"type"
],
"additionalProperties": false
}commerce.product_updated
A product was changed
- Standard
- Yes
- Scope
commerce:read- Version
- 1
data
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"productId": {
"type": "string",
"pattern": "^prd_[0-9a-hjkmnp-tv-z]{26}$",
"description": "A product id: prd_ and 26 letters and digits."
},
"name": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"service",
"physical",
"digital",
"access",
"bundle",
"gift_card",
"shipping"
]
}
},
"required": [
"productId",
"name",
"type"
],
"additionalProperties": false
}commerce.quote_requested
A customer asked for a quote
- Standard
- Yes
- Scope
commerce:read- Version
- 1
data
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"requestId": {
"type": "string",
"pattern": "^qr_[0-9a-hjkmnp-tv-z]{26}$",
"description": "A quote request id: qr_ and 26 letters and digits."
},
"productId": {
"type": "string",
"pattern": "^prd_[0-9a-hjkmnp-tv-z]{26}$",
"description": "A product id: prd_ and 26 letters and digits."
},
"customerId": {
"type": "string",
"pattern": "^cus_[0-9a-hjkmnp-tv-z]{26}$",
"description": "A customer id: cus_ and 26 letters and digits."
}
},
"required": [
"requestId",
"productId",
"customerId"
],
"additionalProperties": false
}commerce.stored_value_changed
A gift card or store credit balance changed
- Standard
- Yes
- Scope
commerce:read- Version
- 1
data
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"customerId": {
"type": "string",
"pattern": "^cus_[0-9a-hjkmnp-tv-z]{26}$",
"description": "A customer id: cus_ and 26 letters and digits."
},
"giftCardId": {
"type": "string",
"pattern": "^gc_[0-9a-hjkmnp-tv-z]{26}$",
"description": "A gift card id: gc_ and 26 letters and digits."
},
"credit": {
"type": "boolean"
},
"change": {
"type": "string",
"enum": [
"issued",
"used",
"refunded",
"released",
"voided"
]
},
"amountMinor": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"currency": {
"type": "string"
}
},
"required": [
"customerId",
"giftCardId",
"credit",
"change",
"amountMinor",
"currency"
],
"additionalProperties": false
}conversation.received
A message came in
- Standard
- Yes
- Scope
inbox:read- Version
- 1
data
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"customerId": {
"anyOf": [
{
"type": "string",
"pattern": "^cus_[0-9a-hjkmnp-tv-z]{26}$",
"description": "A customer id: cus_ and 26 letters and digits."
},
{
"type": "null"
}
]
},
"channel": {
"type": "string"
},
"messageId": {
"type": "string",
"pattern": "^cvm_[0-9a-hjkmnp-tv-z]{26}$",
"description": "A conversation message id: cvm_ and 26 letters and digits."
}
},
"required": [
"customerId",
"channel",
"messageId"
],
"additionalProperties": false
}conversation.replied
A reply went out in a conversation
- Standard
- Only when picked
- Version
- 1
data
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"customerId": {
"anyOf": [
{
"type": "string",
"pattern": "^cus_[0-9a-hjkmnp-tv-z]{26}$",
"description": "A customer id: cus_ and 26 letters and digits."
},
{
"type": "null"
}
]
},
"channel": {
"type": "string"
},
"messageId": {
"type": "string",
"pattern": "^cvm_[0-9a-hjkmnp-tv-z]{26}$",
"description": "A conversation message id: cvm_ and 26 letters and digits."
}
},
"required": [
"customerId",
"channel",
"messageId"
],
"additionalProperties": false
}conversion.recorded
A visit turned into a booking, form, order or signup
- Standard
- Only when picked
- Version
- 1
data
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"kind": {
"type": "string",
"enum": [
"form",
"booking",
"order",
"subscribe"
]
},
"source": {
"type": "string"
},
"medium": {
"type": "string"
},
"campaign": {
"type": "string"
}
},
"required": [
"kind",
"source",
"medium",
"campaign"
],
"additionalProperties": false
}customer.added
A new customer was added to your list
- Standard
- Yes
- Scope
customers:read- Version
- 1
data
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"customerId": {
"type": "string",
"pattern": "^cus_[0-9a-hjkmnp-tv-z]{26}$",
"description": "A customer id: cus_ and 26 letters and digits."
},
"source": {
"type": "string"
},
"imported": {
"type": "boolean"
}
},
"required": [
"customerId",
"source",
"imported"
],
"additionalProperties": false
}customer.dependent_added
A customer added someone they book for
- Standard
- Yes
- Scope
customers:read- Version
- 1
data
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"customerId": {
"type": "string",
"pattern": "^cus_[0-9a-hjkmnp-tv-z]{26}$",
"description": "A customer id: cus_ and 26 letters and digits."
},
"dependentId": {
"type": "string",
"pattern": "^dep_[0-9a-hjkmnp-tv-z]{26}$",
"description": "A dependent id: dep_ and 26 letters and digits."
},
"kind": {
"type": "string",
"enum": [
"child",
"pet",
"adult"
]
}
},
"required": [
"customerId",
"dependentId",
"kind"
],
"additionalProperties": false
}customer.dependent_removed
A customer removed someone they book for
- Standard
- Yes
- Scope
customers:read- Version
- 1
data
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"customerId": {
"type": "string",
"pattern": "^cus_[0-9a-hjkmnp-tv-z]{26}$",
"description": "A customer id: cus_ and 26 letters and digits."
},
"dependentId": {
"type": "string",
"pattern": "^dep_[0-9a-hjkmnp-tv-z]{26}$",
"description": "A dependent id: dep_ and 26 letters and digits."
}
},
"required": [
"customerId",
"dependentId"
],
"additionalProperties": false
}customer.forgotten
A customer was removed
- Standard
- Yes
- Scope
customers:read- Version
- 1
data
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"customerId": {
"type": "string",
"pattern": "^cus_[0-9a-hjkmnp-tv-z]{26}$",
"description": "A customer id: cus_ and 26 letters and digits."
},
"reason": {
"type": "string",
"enum": [
"owner",
"account"
]
}
},
"required": [
"customerId",
"reason"
],
"additionalProperties": false
}customer.joined
A customer made an account with you
- Standard
- Yes
- Scope
customers:read- Version
- 1
data
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"customerId": {
"type": "string",
"pattern": "^cus_[0-9a-hjkmnp-tv-z]{26}$",
"description": "A customer id: cus_ and 26 letters and digits."
},
"linkedGuest": {
"type": "boolean"
}
},
"required": [
"customerId",
"linkedGuest"
],
"additionalProperties": false
}customer.merged
Two customers were merged
- Standard
- Yes
- Scope
customers:read- Version
- 1
data
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"customerId": {
"type": "string",
"pattern": "^cus_[0-9a-hjkmnp-tv-z]{26}$",
"description": "A customer id: cus_ and 26 letters and digits."
},
"mergedFrom": {
"type": "string",
"pattern": "^cus_[0-9a-hjkmnp-tv-z]{26}$",
"description": "A customer id: cus_ and 26 letters and digits."
}
},
"required": [
"customerId",
"mergedFrom"
],
"additionalProperties": false
}domain.added
You added a domain
- Standard
- Only when picked
- Scope
domains:read- Version
- 1
data
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"hostname": {
"type": "string"
}
},
"required": [
"hostname"
],
"additionalProperties": false
}domain.email_added
You started sending email from your domain
- Standard
- Only when picked
- Scope
domains:read- Version
- 1
data
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"domain": {
"type": "string"
},
"address": {
"type": "string"
}
},
"required": [
"domain",
"address"
],
"additionalProperties": false
}domain.email_removed
You stopped sending email from your domain
- Standard
- Only when picked
- Scope
domains:read- Version
- 1
data
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"domain": {
"type": "string"
},
"address": {
"type": "string"
}
},
"required": [
"domain",
"address"
],
"additionalProperties": false
}domain.email_verified
Your emails come from your domain
- Standard
- Only when picked
- Scope
domains:read- Version
- 1
data
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"domain": {
"type": "string"
},
"address": {
"type": "string"
}
},
"required": [
"domain",
"address"
],
"additionalProperties": false
}domain.removed
You removed a domain
- Standard
- Only when picked
- Scope
domains:read- Version
- 1
data
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"hostname": {
"type": "string"
}
},
"required": [
"hostname"
],
"additionalProperties": false
}domain.verified
Your domain is connected
- Standard
- Only when picked
- Scope
domains:read- Version
- 1
data
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"hostname": {
"type": "string"
}
},
"required": [
"hostname"
],
"additionalProperties": false
}form.submitted
A form was sent in
- Standard
- Yes
- Scope
customers:read- Version
- 1
data
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"formId": {
"type": "string",
"pattern": "^frm_[0-9a-hjkmnp-tv-z]{26}$",
"description": "A form id: frm_ and 26 letters and digits."
},
"formKind": {
"type": "string"
},
"sensitive": {
"type": "boolean"
},
"customerId": {
"type": "string",
"pattern": "^cus_[0-9a-hjkmnp-tv-z]{26}$",
"description": "A customer id: cus_ and 26 letters and digits."
}
},
"required": [
"formId",
"formKind",
"sensitive"
],
"additionalProperties": false
}formation.formed
The LLC was formed
- Standard
- Yes
- Scope
formation:read- Version
- 1
data
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"orderId": {
"type": "string",
"pattern": "^fmo_[0-9a-hjkmnp-tv-z]{26}$",
"description": "A formation order id: fmo_ and 26 letters and digits."
},
"state": {
"type": "string",
"minLength": 2,
"maxLength": 2,
"description": "Two-letter state of formation"
},
"hasEin": {
"type": "boolean",
"description": "Whether the EIN has been issued yet"
}
},
"required": [
"orderId",
"state",
"hasEin"
],
"additionalProperties": false
}formation.ordered
An LLC was ordered
- Standard
- Yes
- Scope
formation:read- Version
- 1
data
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"orderId": {
"type": "string",
"pattern": "^fmo_[0-9a-hjkmnp-tv-z]{26}$",
"description": "A formation order id: fmo_ and 26 letters and digits."
},
"state": {
"type": "string",
"minLength": 2,
"maxLength": 2,
"description": "Two-letter state of formation"
}
},
"required": [
"orderId",
"state"
],
"additionalProperties": false
}formation.rejected
An LLC order was turned down
- Standard
- Yes
- Scope
formation:read- Version
- 1
data
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"orderId": {
"type": "string",
"pattern": "^fmo_[0-9a-hjkmnp-tv-z]{26}$",
"description": "A formation order id: fmo_ and 26 letters and digits."
},
"state": {
"type": "string",
"minLength": 2,
"maxLength": 2,
"description": "Two-letter state of formation"
}
},
"required": [
"orderId",
"state"
],
"additionalProperties": false
}grant.cancelled
A pack or membership was cancelled
- Standard
- Only when picked
- Scope
grants:read- Version
- 1
data
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"kind": {
"type": "string"
}
},
"required": [
"kind"
],
"additionalProperties": false
}integration.connected
An outside service was connected or given more access
- Standard
- Only when picked
- Version
- 1
data
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"integration": {
"type": "string"
},
"capabilities": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"integration",
"capabilities"
],
"additionalProperties": false
}integration.disconnected
An outside service was disconnected
- Standard
- Only when picked
- Version
- 1
data
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"integration": {
"type": "string"
},
"capabilities": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"integration",
"capabilities"
],
"additionalProperties": false
}integration.needs_reconnect
A connected service stopped working and needs reconnecting
- Standard
- Only when picked
- Version
- 1
data
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"integration": {
"type": "string"
},
"capabilities": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"integration",
"capabilities"
],
"additionalProperties": false
}integration.received
Something a connected service read is waiting to be filed
- Standard
- Only when picked
- Version
- 1
data
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"integration": {
"type": "string"
},
"itemId": {
"type": "string",
"pattern": "^iti_[0-9a-hjkmnp-tv-z]{26}$",
"description": "A integration item id: iti_ and 26 letters and digits."
}
},
"required": [
"integration",
"itemId"
],
"additionalProperties": false
}integration.shipment_updated
A shipping service said where a package is now
- Standard
- Only when picked
- Version
- 1
data
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"integration": {
"type": "string"
},
"carrier": {
"type": "string"
},
"trackingNumber": {
"type": "string"
},
"state": {
"type": "string",
"enum": [
"pre_transit",
"in_transit",
"delivered",
"returned",
"failure",
"unknown"
]
},
"at": {
"type": [
"string",
"null"
]
},
"details": {
"type": [
"string",
"null"
]
}
},
"required": [
"integration",
"carrier",
"trackingNumber",
"state",
"at",
"details"
],
"additionalProperties": false
}listing.review_replied
A reply to a Google review was posted, failed or is waiting
- Standard
- Only when picked
- Scope
listings:read- Version
- 1
data
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"outcome": {
"type": "string",
"enum": [
"posted",
"failed",
"waiting"
]
}
},
"required": [
"outcome"
],
"additionalProperties": false
}location.saved
A location was added or changed
- Standard
- Only when picked
- Scope
business:read- Version
- 1
data
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"kind": {
"type": "string",
"description": "place, venue or online"
},
"created": {
"type": "boolean",
"description": "Whether it was just added"
}
},
"required": [
"kind",
"created"
],
"additionalProperties": false
}loyalty.reward_earned
A customer earned a reward
- Standard
- Yes
- Scope
loyalty:read- Version
- 1
data
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"grantId": {
"type": "string",
"pattern": "^grt_[0-9a-hjkmnp-tv-z]{26}$",
"description": "A grant id: grt_ and 26 letters and digits."
},
"customerId": {
"type": "string",
"pattern": "^cus_[0-9a-hjkmnp-tv-z]{26}$",
"description": "A customer id: cus_ and 26 letters and digits."
},
"programId": {
"type": "string",
"pattern": "^lyp_[0-9a-hjkmnp-tv-z]{26}$",
"description": "A loyalty program id: lyp_ and 26 letters and digits."
},
"label": {
"type": "string"
}
},
"required": [
"grantId",
"customerId",
"programId",
"label"
],
"additionalProperties": false
}message.failed
A message to a customer failed
- Standard
- Only when picked
- Version
- 1
data
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"customerId": {
"type": "string",
"pattern": "^cus_[0-9a-hjkmnp-tv-z]{26}$",
"description": "A customer id: cus_ and 26 letters and digits."
},
"template": {
"type": "string"
},
"channel": {
"anyOf": [
{
"type": "string",
"enum": [
"sms",
"whatsapp",
"email",
"instagram",
"messenger"
]
},
{
"type": "null"
}
]
},
"purpose": {
"type": "string",
"enum": [
"transactional",
"marketing"
]
},
"reason": {
"description": "Why, when it wasn’t sent.",
"type": "string"
}
},
"required": [
"customerId",
"template",
"channel",
"purpose"
],
"additionalProperties": false
}message.sent
A message to a customer went out
- Standard
- Only when picked
- Version
- 1
data
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"customerId": {
"type": "string",
"pattern": "^cus_[0-9a-hjkmnp-tv-z]{26}$",
"description": "A customer id: cus_ and 26 letters and digits."
},
"template": {
"type": "string"
},
"channel": {
"anyOf": [
{
"type": "string",
"enum": [
"sms",
"whatsapp",
"email",
"instagram",
"messenger"
]
},
{
"type": "null"
}
]
},
"purpose": {
"type": "string",
"enum": [
"transactional",
"marketing"
]
},
"reason": {
"description": "Why, when it wasn’t sent.",
"type": "string"
}
},
"required": [
"customerId",
"template",
"channel",
"purpose"
],
"additionalProperties": false
}message.skipped
A message to a customer wasn’t sent
- Standard
- Only when picked
- Version
- 1
data
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"customerId": {
"type": "string",
"pattern": "^cus_[0-9a-hjkmnp-tv-z]{26}$",
"description": "A customer id: cus_ and 26 letters and digits."
},
"template": {
"type": "string"
},
"channel": {
"anyOf": [
{
"type": "string",
"enum": [
"sms",
"whatsapp",
"email",
"instagram",
"messenger"
]
},
{
"type": "null"
}
]
},
"purpose": {
"type": "string",
"enum": [
"transactional",
"marketing"
]
},
"reason": {
"description": "Why, when it wasn’t sent.",
"type": "string"
}
},
"required": [
"customerId",
"template",
"channel",
"purpose"
],
"additionalProperties": false
}message.unknown
A message to a customer may not have gone out
- Standard
- Only when picked
- Version
- 1
data
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"customerId": {
"type": "string",
"pattern": "^cus_[0-9a-hjkmnp-tv-z]{26}$",
"description": "A customer id: cus_ and 26 letters and digits."
},
"template": {
"type": "string"
},
"channel": {
"anyOf": [
{
"type": "string",
"enum": [
"sms",
"whatsapp",
"email",
"instagram",
"messenger"
]
},
{
"type": "null"
}
]
},
"purpose": {
"type": "string",
"enum": [
"transactional",
"marketing"
]
},
"reason": {
"description": "Why, when it wasn’t sent.",
"type": "string"
}
},
"required": [
"customerId",
"template",
"channel",
"purpose"
],
"additionalProperties": false
}module.active
A tool turned on
- Standard
- Only when picked
- Version
- 1
data
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"from": {
"type": "string",
"enum": [
"off",
"active",
"winding_down"
]
},
"reason": {
"type": [
"string",
"null"
]
}
},
"required": [
"from",
"reason"
],
"additionalProperties": false
}module.off
A tool turned off
- Standard
- Only when picked
- Version
- 1
data
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"from": {
"type": "string",
"enum": [
"off",
"active",
"winding_down"
]
},
"reason": {
"type": [
"string",
"null"
]
}
},
"required": [
"from",
"reason"
],
"additionalProperties": false
}module.winding_down
A tool is winding down: it keeps its commitments and takes nothing new
- Standard
- Only when picked
- Version
- 1
data
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"from": {
"type": "string",
"enum": [
"off",
"active",
"winding_down"
]
},
"reason": {
"type": [
"string",
"null"
]
}
},
"required": [
"from",
"reason"
],
"additionalProperties": false
}offering.archived
An offering was archived
- Standard
- Only when picked
- Scope
offerings:read- Version
- 1
data
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"offeringId": {
"type": "string",
"pattern": "^off_[0-9a-hjkmnp-tv-z]{26}$",
"description": "A offering id: off_ and 26 letters and digits."
},
"removed": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"kept": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
},
"required": [
"offeringId",
"removed",
"kept"
],
"additionalProperties": false
}offering.attended
Someone came to a session
- Standard
- Only when picked
- Scope
offerings:read- Version
- 1
data
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"attendanceId": {
"type": "string",
"pattern": "^att_[0-9a-hjkmnp-tv-z]{26}$",
"description": "A attendance id: att_ and 26 letters and digits."
},
"enrollmentId": {
"type": "string",
"pattern": "^bk_[0-9a-hjkmnp-tv-z]{26}$",
"description": "A booking id: bk_ and 26 letters and digits."
},
"sessionId": {
"type": "string",
"pattern": "^ses_[0-9a-hjkmnp-tv-z]{26}$",
"description": "A session id: ses_ and 26 letters and digits."
},
"offeringId": {
"type": "string",
"pattern": "^off_[0-9a-hjkmnp-tv-z]{26}$",
"description": "A offering id: off_ and 26 letters and digits."
},
"offeringKind": {
"type": "string"
},
"productId": {
"type": "string",
"pattern": "^prd_[0-9a-hjkmnp-tv-z]{26}$",
"description": "A product id: prd_ and 26 letters and digits."
},
"customerId": {
"type": "string",
"pattern": "^cus_[0-9a-hjkmnp-tv-z]{26}$",
"description": "A customer id: cus_ and 26 letters and digits."
},
"attendeeCustomerId": {
"anyOf": [
{
"type": "string",
"pattern": "^cus_[0-9a-hjkmnp-tv-z]{26}$",
"description": "A customer id: cus_ and 26 letters and digits."
},
{
"type": "null"
}
]
},
"attendeeDependentId": {
"anyOf": [
{
"type": "string",
"pattern": "^dep_[0-9a-hjkmnp-tv-z]{26}$",
"description": "A dependent id: dep_ and 26 letters and digits."
},
{
"type": "null"
}
]
},
"by": {
"type": "string",
"enum": [
"staff",
"link",
"code",
"door"
]
},
"checkedIn": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
},
"required": [
"attendanceId",
"enrollmentId",
"sessionId",
"offeringId",
"offeringKind",
"productId",
"customerId",
"attendeeCustomerId",
"attendeeDependentId",
"by",
"checkedIn"
],
"additionalProperties": false
}offering.cancelled
A booking was cancelled
- Standard
- Yes
- Scope
offerings:read- Version
- 1
data
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"enrollmentId": {
"type": "string",
"pattern": "^bk_[0-9a-hjkmnp-tv-z]{26}$",
"description": "A booking id: bk_ and 26 letters and digits."
},
"offeringId": {
"type": "string",
"pattern": "^off_[0-9a-hjkmnp-tv-z]{26}$",
"description": "A offering id: off_ and 26 letters and digits."
},
"admissionId": {
"type": "string",
"pattern": "^adm_[0-9a-hjkmnp-tv-z]{26}$",
"description": "A admission id: adm_ and 26 letters and digits."
},
"productId": {
"type": "string",
"pattern": "^prd_[0-9a-hjkmnp-tv-z]{26}$",
"description": "A product id: prd_ and 26 letters and digits."
},
"customerId": {
"type": "string",
"pattern": "^cus_[0-9a-hjkmnp-tv-z]{26}$",
"description": "A customer id: cus_ and 26 letters and digits."
},
"attendeeCustomerId": {
"anyOf": [
{
"type": "string",
"pattern": "^cus_[0-9a-hjkmnp-tv-z]{26}$",
"description": "A customer id: cus_ and 26 letters and digits."
},
{
"type": "null"
}
]
},
"attendeeDependentId": {
"anyOf": [
{
"type": "string",
"pattern": "^dep_[0-9a-hjkmnp-tv-z]{26}$",
"description": "A dependent id: dep_ and 26 letters and digits."
},
{
"type": "null"
}
]
},
"sessionId": {
"anyOf": [
{
"type": "string",
"pattern": "^ses_[0-9a-hjkmnp-tv-z]{26}$",
"description": "A session id: ses_ and 26 letters and digits."
},
{
"type": "null"
}
]
},
"seats": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"startsAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
},
{
"type": "null"
}
]
},
"visitId": {
"anyOf": [
{
"type": "string",
"pattern": "^bk_[0-9a-hjkmnp-tv-z]{26}$",
"description": "A booking id: bk_ and 26 letters and digits."
},
{
"type": "null"
}
]
},
"by": {
"type": "string"
},
"was": {
"type": "string"
},
"refundMinor": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
},
"required": [
"enrollmentId",
"offeringId",
"admissionId",
"productId",
"customerId",
"attendeeCustomerId",
"attendeeDependentId",
"sessionId",
"seats",
"startsAt",
"by",
"was",
"refundMinor"
],
"additionalProperties": false
}offering.enrolled
Someone booked a place
- Standard
- Yes
- Scope
offerings:read- Version
- 1
data
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"enrollmentId": {
"type": "string",
"pattern": "^bk_[0-9a-hjkmnp-tv-z]{26}$",
"description": "A booking id: bk_ and 26 letters and digits."
},
"offeringId": {
"type": "string",
"pattern": "^off_[0-9a-hjkmnp-tv-z]{26}$",
"description": "A offering id: off_ and 26 letters and digits."
},
"admissionId": {
"type": "string",
"pattern": "^adm_[0-9a-hjkmnp-tv-z]{26}$",
"description": "A admission id: adm_ and 26 letters and digits."
},
"productId": {
"type": "string",
"pattern": "^prd_[0-9a-hjkmnp-tv-z]{26}$",
"description": "A product id: prd_ and 26 letters and digits."
},
"customerId": {
"type": "string",
"pattern": "^cus_[0-9a-hjkmnp-tv-z]{26}$",
"description": "A customer id: cus_ and 26 letters and digits."
},
"attendeeCustomerId": {
"anyOf": [
{
"type": "string",
"pattern": "^cus_[0-9a-hjkmnp-tv-z]{26}$",
"description": "A customer id: cus_ and 26 letters and digits."
},
{
"type": "null"
}
]
},
"attendeeDependentId": {
"anyOf": [
{
"type": "string",
"pattern": "^dep_[0-9a-hjkmnp-tv-z]{26}$",
"description": "A dependent id: dep_ and 26 letters and digits."
},
{
"type": "null"
}
]
},
"sessionId": {
"anyOf": [
{
"type": "string",
"pattern": "^ses_[0-9a-hjkmnp-tv-z]{26}$",
"description": "A session id: ses_ and 26 letters and digits."
},
{
"type": "null"
}
]
},
"seats": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"startsAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
},
{
"type": "null"
}
]
},
"visitId": {
"anyOf": [
{
"type": "string",
"pattern": "^bk_[0-9a-hjkmnp-tv-z]{26}$",
"description": "A booking id: bk_ and 26 letters and digits."
},
{
"type": "null"
}
]
},
"paidWith": {
"type": "string",
"enum": [
"card",
"door",
"free",
"grant"
]
}
},
"required": [
"enrollmentId",
"offeringId",
"admissionId",
"productId",
"customerId",
"attendeeCustomerId",
"attendeeDependentId",
"sessionId",
"seats",
"startsAt",
"paidWith"
],
"additionalProperties": false
}offering.no_show
Someone didn’t show for a session
- Standard
- Only when picked
- Scope
offerings:read- Version
- 1
data
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"attendanceId": {
"type": "string",
"pattern": "^att_[0-9a-hjkmnp-tv-z]{26}$",
"description": "A attendance id: att_ and 26 letters and digits."
},
"enrollmentId": {
"type": "string",
"pattern": "^bk_[0-9a-hjkmnp-tv-z]{26}$",
"description": "A booking id: bk_ and 26 letters and digits."
},
"sessionId": {
"type": "string",
"pattern": "^ses_[0-9a-hjkmnp-tv-z]{26}$",
"description": "A session id: ses_ and 26 letters and digits."
},
"offeringId": {
"type": "string",
"pattern": "^off_[0-9a-hjkmnp-tv-z]{26}$",
"description": "A offering id: off_ and 26 letters and digits."
},
"offeringKind": {
"type": "string"
},
"productId": {
"type": "string",
"pattern": "^prd_[0-9a-hjkmnp-tv-z]{26}$",
"description": "A product id: prd_ and 26 letters and digits."
},
"customerId": {
"type": "string",
"pattern": "^cus_[0-9a-hjkmnp-tv-z]{26}$",
"description": "A customer id: cus_ and 26 letters and digits."
},
"attendeeCustomerId": {
"anyOf": [
{
"type": "string",
"pattern": "^cus_[0-9a-hjkmnp-tv-z]{26}$",
"description": "A customer id: cus_ and 26 letters and digits."
},
{
"type": "null"
}
]
},
"attendeeDependentId": {
"anyOf": [
{
"type": "string",
"pattern": "^dep_[0-9a-hjkmnp-tv-z]{26}$",
"description": "A dependent id: dep_ and 26 letters and digits."
},
{
"type": "null"
}
]
},
"by": {
"type": "string",
"enum": [
"staff",
"link",
"code",
"door"
]
},
"checkedIn": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
},
"required": [
"attendanceId",
"enrollmentId",
"sessionId",
"offeringId",
"offeringKind",
"productId",
"customerId",
"attendeeCustomerId",
"attendeeDependentId",
"by",
"checkedIn"
],
"additionalProperties": false
}offering.saved
An offering was set up or changed
- Standard
- Only when picked
- Scope
offerings:read- Version
- 1
data
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"offeringId": {
"type": "string",
"pattern": "^off_[0-9a-hjkmnp-tv-z]{26}$",
"description": "A offering id: off_ and 26 letters and digits."
},
"created": {
"type": "boolean"
},
"added": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
},
"required": [
"offeringId",
"created",
"added"
],
"additionalProperties": false
}offering.session_called_off
A session was called off
- Standard
- Yes
- Scope
offerings:read- Version
- 1
data
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"sessionId": {
"type": "string",
"pattern": "^ses_[0-9a-hjkmnp-tv-z]{26}$",
"description": "A session id: ses_ and 26 letters and digits."
},
"offeringId": {
"type": "string",
"pattern": "^off_[0-9a-hjkmnp-tv-z]{26}$",
"description": "A offering id: off_ and 26 letters and digits."
},
"startsAt": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
},
"told": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"refundMinor": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"credits": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"makeUps": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
},
"required": [
"sessionId",
"offeringId",
"startsAt",
"told",
"refundMinor",
"credits",
"makeUps"
],
"additionalProperties": false
}offering.session_changed
A session changed
- Standard
- Yes
- Scope
offerings:read- Version
- 1
data
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"sessionId": {
"type": "string",
"pattern": "^ses_[0-9a-hjkmnp-tv-z]{26}$",
"description": "A session id: ses_ and 26 letters and digits."
},
"offeringId": {
"type": "string",
"pattern": "^off_[0-9a-hjkmnp-tv-z]{26}$",
"description": "A offering id: off_ and 26 letters and digits."
},
"startsAt": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
},
"endsAt": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
},
"fromStartsAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
},
{
"type": "null"
}
]
},
"changed": {
"type": "array",
"items": {
"type": "string"
}
},
"told": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
},
"required": [
"sessionId",
"offeringId",
"startsAt",
"endsAt",
"fromStartsAt",
"changed",
"told"
],
"additionalProperties": false
}offering.transferred
A booking moved or changed hands
- Standard
- Yes
- Scope
offerings:read- Version
- 1
data
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"enrollmentId": {
"type": "string",
"pattern": "^bk_[0-9a-hjkmnp-tv-z]{26}$",
"description": "A booking id: bk_ and 26 letters and digits."
},
"offeringId": {
"type": "string",
"pattern": "^off_[0-9a-hjkmnp-tv-z]{26}$",
"description": "A offering id: off_ and 26 letters and digits."
},
"admissionId": {
"type": "string",
"pattern": "^adm_[0-9a-hjkmnp-tv-z]{26}$",
"description": "A admission id: adm_ and 26 letters and digits."
},
"productId": {
"type": "string",
"pattern": "^prd_[0-9a-hjkmnp-tv-z]{26}$",
"description": "A product id: prd_ and 26 letters and digits."
},
"customerId": {
"type": "string",
"pattern": "^cus_[0-9a-hjkmnp-tv-z]{26}$",
"description": "A customer id: cus_ and 26 letters and digits."
},
"attendeeCustomerId": {
"anyOf": [
{
"type": "string",
"pattern": "^cus_[0-9a-hjkmnp-tv-z]{26}$",
"description": "A customer id: cus_ and 26 letters and digits."
},
{
"type": "null"
}
]
},
"attendeeDependentId": {
"anyOf": [
{
"type": "string",
"pattern": "^dep_[0-9a-hjkmnp-tv-z]{26}$",
"description": "A dependent id: dep_ and 26 letters and digits."
},
{
"type": "null"
}
]
},
"sessionId": {
"anyOf": [
{
"type": "string",
"pattern": "^ses_[0-9a-hjkmnp-tv-z]{26}$",
"description": "A session id: ses_ and 26 letters and digits."
},
{
"type": "null"
}
]
},
"seats": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"startsAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
},
{
"type": "null"
}
]
},
"visitId": {
"anyOf": [
{
"type": "string",
"pattern": "^bk_[0-9a-hjkmnp-tv-z]{26}$",
"description": "A booking id: bk_ and 26 letters and digits."
},
{
"type": "null"
}
]
},
"fromSessionId": {
"type": "string",
"pattern": "^ses_[0-9a-hjkmnp-tv-z]{26}$",
"description": "A session id: ses_ and 26 letters and digits."
},
"fromAttendeeCustomerId": {
"anyOf": [
{
"type": "string",
"pattern": "^cus_[0-9a-hjkmnp-tv-z]{26}$",
"description": "A customer id: cus_ and 26 letters and digits."
},
{
"type": "null"
}
]
}
},
"required": [
"enrollmentId",
"offeringId",
"admissionId",
"productId",
"customerId",
"attendeeCustomerId",
"attendeeDependentId",
"sessionId",
"seats",
"startsAt"
],
"additionalProperties": false
}offering.waitlisted
Someone joined a waitlist
- Standard
- Yes
- Scope
offerings:read- Version
- 1
data
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"enrollmentId": {
"type": "string",
"pattern": "^bk_[0-9a-hjkmnp-tv-z]{26}$",
"description": "A booking id: bk_ and 26 letters and digits."
},
"offeringId": {
"type": "string",
"pattern": "^off_[0-9a-hjkmnp-tv-z]{26}$",
"description": "A offering id: off_ and 26 letters and digits."
},
"admissionId": {
"type": "string",
"pattern": "^adm_[0-9a-hjkmnp-tv-z]{26}$",
"description": "A admission id: adm_ and 26 letters and digits."
},
"productId": {
"type": "string",
"pattern": "^prd_[0-9a-hjkmnp-tv-z]{26}$",
"description": "A product id: prd_ and 26 letters and digits."
},
"customerId": {
"type": "string",
"pattern": "^cus_[0-9a-hjkmnp-tv-z]{26}$",
"description": "A customer id: cus_ and 26 letters and digits."
},
"attendeeCustomerId": {
"anyOf": [
{
"type": "string",
"pattern": "^cus_[0-9a-hjkmnp-tv-z]{26}$",
"description": "A customer id: cus_ and 26 letters and digits."
},
{
"type": "null"
}
]
},
"attendeeDependentId": {
"anyOf": [
{
"type": "string",
"pattern": "^dep_[0-9a-hjkmnp-tv-z]{26}$",
"description": "A dependent id: dep_ and 26 letters and digits."
},
{
"type": "null"
}
]
},
"sessionId": {
"anyOf": [
{
"type": "string",
"pattern": "^ses_[0-9a-hjkmnp-tv-z]{26}$",
"description": "A session id: ses_ and 26 letters and digits."
},
{
"type": "null"
}
]
},
"seats": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"startsAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
},
{
"type": "null"
}
]
},
"visitId": {
"anyOf": [
{
"type": "string",
"pattern": "^bk_[0-9a-hjkmnp-tv-z]{26}$",
"description": "A booking id: bk_ and 26 letters and digits."
},
{
"type": "null"
}
]
}
},
"required": [
"enrollmentId",
"offeringId",
"admissionId",
"productId",
"customerId",
"attendeeCustomerId",
"attendeeDependentId",
"sessionId",
"seats",
"startsAt"
],
"additionalProperties": false
}payments.account_changed
Your payments account changed status
- Standard
- Only when picked
- Scope
payments:read- Version
- 1
data
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"from": {
"type": "string"
},
"to": {
"type": "string"
}
},
"required": [
"from",
"to"
],
"additionalProperties": false
}playbook.disabled
You turned off an automation
- Standard
- Only when picked
- Version
- 1
data
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {},
"additionalProperties": false
}playbook.enabled
You turned on an automation
- Standard
- Only when picked
- Version
- 1
data
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "The built-in automation’s version, e.g. 1.2.0."
},
"approvalId": {
"type": "string",
"pattern": "^apv_[0-9a-hjkmnp-tv-z]{26}$",
"description": "A approval id: apv_ and 26 letters and digits."
}
},
"required": [
"version",
"approvalId"
],
"additionalProperties": false
}policy.accepted
You accepted a policy
- Standard
- Only when picked
- Version
- 1
data
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"kind": {
"type": "string"
},
"version": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
},
"required": [
"kind",
"version"
],
"additionalProperties": false
}record.checked
Your address was checked
- Standard
- Only when picked
- Version
- 1
data
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"kind": {
"type": "string",
"enum": [
"address",
"serviceArea"
],
"description": "What was checked: the address or the service area"
},
"version": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"checked": {
"type": "boolean",
"description": "Found on the map; false asks the owner to confirm it"
}
},
"required": [
"kind",
"version",
"checked"
],
"additionalProperties": false
}record.updated
Your business details changed
- Standard
- Only when picked
- Scope
business:read- Version
- 1
data
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"kind": {
"type": "string",
"description": "Which record: hours, contact…"
},
"version": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
},
"required": [
"kind",
"version"
],
"additionalProperties": false
}requirement.met
A form was signed or a record sent for a booking
- Standard
- Only when picked
- Scope
forms:read- Version
- 1
data
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"customerId": {
"type": "string",
"pattern": "^cus_[0-9a-hjkmnp-tv-z]{26}$",
"description": "A customer id: cus_ and 26 letters and digits."
},
"dependentId": {
"anyOf": [
{
"type": "string",
"pattern": "^dep_[0-9a-hjkmnp-tv-z]{26}$",
"description": "A dependent id: dep_ and 26 letters and digits."
},
{
"type": "null"
}
]
},
"key": {
"type": "string"
}
},
"required": [
"customerId",
"dependentId",
"key"
],
"additionalProperties": false
}review.received
A review came in
- Standard
- Yes
- Scope
reviews:read- Version
- 1
data
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"customerId": {
"anyOf": [
{
"type": "string",
"pattern": "^cus_[0-9a-hjkmnp-tv-z]{26}$",
"description": "A customer id: cus_ and 26 letters and digits."
},
{
"type": "null"
}
]
},
"rating": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
},
"required": [
"customerId",
"rating"
],
"additionalProperties": false
}review.requested
A customer was asked for a review
- Standard
- Only when picked
- Scope
reviews:read- Version
- 1
data
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"customerId": {
"type": "string",
"pattern": "^cus_[0-9a-hjkmnp-tv-z]{26}$",
"description": "A customer id: cus_ and 26 letters and digits."
}
},
"required": [
"customerId"
],
"additionalProperties": false
}site.published
The website was published
- Standard
- Yes
- Scope
site:read- Version
- 1
data
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"revision": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"first": {
"type": "boolean"
}
},
"required": [
"revision",
"first"
],
"additionalProperties": false
}suggestion.requested
An automation needs you: a policy to accept, or a new version to review
- Standard
- Only when picked
- Version
- 1
data
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"kind": {
"type": "string",
"enum": [
"policy_needed",
"playbook_review"
]
},
"command": {
"description": "For `policy_needed`.",
"type": "string"
},
"policy": {
"description": "For `policy_needed`.",
"type": "string"
},
"version": {
"description": "For `playbook_review`.",
"type": "string"
},
"paused": {
"description": "For `playbook_review`.",
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
},
"required": [
"kind"
],
"additionalProperties": false
}texting.approved
Texting is approved for your business
- Standard
- Only when picked
- Scope
messaging:read- Version
- 1
data
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"number": {
"type": "string"
}
},
"required": [
"number"
],
"additionalProperties": false
}texting.rejected
The carriers turned down your texting registration
- Standard
- Only when picked
- Scope
messaging:read- Version
- 1
data
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"reason": {
"type": "string"
}
},
"required": [
"reason"
],
"additionalProperties": false
}workflow.disabled
You turned off an automation you built
- Standard
- Only when picked
- Version
- 1
data
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {},
"additionalProperties": false
}workflow.published
You published an automation you built
- Standard
- Only when picked
- Version
- 1
data
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"version": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"approvalId": {
"type": "string",
"pattern": "^apv_[0-9a-hjkmnp-tv-z]{26}$",
"description": "A approval id: apv_ and 26 letters and digits."
}
},
"required": [
"version",
"approvalId"
],
"additionalProperties": false
}