changedOutput schema / (root)
Previous value: -nullNew value: +{
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
+ "additionalProperties": {},
+ "properties": {
+ "assistantInstructions": {
+ "description": "HubSpot Play: the steps to walk the customer through, one at a time.",
+ "type": "string"
+ },
+ "createLinks": {
+ "additionalProperties": {},
+ "description": "Links for creating a signup Play.",
+ "properties": {
+ "hubspot": {
+ "description": "Opens a new HubSpot form signups Play.",
+ "type": "string"
+ },
+ "webhook": {
+ "description": "Opens a new Webhook signups Play for other sources.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "hubspot",
+ "webhook"
+ ],
+ "type": "object"
+ },
+ "credentialInstructions": {
+ "description": "Webhook Play: how the owner or admin stores the workspace key; never ask for it in chat.",
+ "type": "string"
+ },
+ "evidenceLimit": {
+ "description": "What savedContacts can and can't prove.",
+ "type": "string"
+ },
+ "guide": {
+ "additionalProperties": {},
+ "description": "Webhook Play: setup steps, request format, test steps and troubleshooting.",
+ "properties": {
+ "endpoint": {
+ "description": "The URL signups are sent to.",
+ "type": "string"
+ },
+ "errors": {
+ "description": "Troubleshooting for each error.",
+ "items": {
+ "additionalProperties": {},
+ "properties": {
+ "code": {
+ "description": "The HTTP status or error code returned.",
+ "type": "string"
+ },
+ "fix": {
+ "description": "How to fix it.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "code",
+ "fix"
+ ],
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "example": {
+ "additionalProperties": {},
+ "description": "An example JSON body (eventId, expectedRevision, name, email, dryRun).",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "fields": {
+ "description": "The body fields to send.",
+ "items": {
+ "additionalProperties": {},
+ "properties": {
+ "help": {
+ "description": "Why it matters and how to fill it.",
+ "type": "string"
+ },
+ "key": {
+ "description": "The body field name.",
+ "type": "string"
+ },
+ "kind": {
+ "description": "Contact property or Static value.",
+ "type": "string"
+ },
+ "value": {
+ "description": "What to map into it, or the static value to send.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "key",
+ "value",
+ "kind",
+ "help"
+ ],
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "headers": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Request headers to send; the Authorization value is a placeholder for the workspace key, never a real key.",
+ "propertyNames": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "method": {
+ "description": "The HTTP method to use (POST).",
+ "type": "string"
+ },
+ "notes": {
+ "description": "Rules about retries, identities and what an accepted event proves.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "setupUrl": {
+ "description": "The product page for this webhook setup.",
+ "type": "string"
+ },
+ "steps": {
+ "description": "Setup and test steps, in order.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "required": [
+ "endpoint",
+ "method",
+ "setupUrl",
+ "headers",
+ "example",
+ "fields",
+ "steps",
+ "notes",
+ "errors"
+ ],
+ "type": "object"
+ },
+ "instructions": {
+ "description": "Without playId: how to choose and create the Play.",
+ "type": "string"
+ },
+ "play": {
+ "additionalProperties": {},
+ "description": "With playId: the Play being set up.",
+ "properties": {
+ "id": {
+ "description": "The Play's id.",
+ "type": "string"
+ },
+ "name": {
+ "description": "The Play's name.",
+ "type": "string"
+ },
+ "revision": {
+ "description": "The Play's current revision; webhook senders send it as expectedRevision.",
+ "type": "number"
+ },
+ "status": {
+ "description": "active, experimental, paused or archived; it must be active to receive signups.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "id",
+ "name",
+ "status",
+ "revision"
+ ],
+ "type": "object"
+ },
+ "savedContacts": {
+ "description": "With playId: up to five most recent signups the Play saved; match the exact test contact.",
+ "items": {
+ "additionalProperties": {},
+ "properties": {
+ "decision": {
+ "description": "undecided (waiting in review), good_fit or not_a_fit.",
+ "type": "string"
+ },
+ "email": {
+ "description": "Their email; null when none was saved.",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "enrolled": {
+ "description": "True when they were added to the Sequence.",
+ "type": "boolean"
+ },
+ "name": {
+ "description": "The contact's name as saved.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "name",
+ "email",
+ "decision",
+ "enrolled"
+ ],
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "sequence": {
+ "description": "With playId: the Play's welcome sequences and whether each is approved.",
+ "items": {
+ "additionalProperties": {},
+ "properties": {
+ "approved": {
+ "description": "False when its current messages have never been approved; it then sends nothing.",
+ "type": "boolean"
+ },
+ "id": {
+ "description": "The Sequence's id.",
+ "type": "string"
+ },
+ "name": {
+ "description": "Its name.",
+ "type": "string"
+ },
+ "status": {
+ "description": "Its current status, such as active or paused.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "id",
+ "name",
+ "status",
+ "approved"
+ ],
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "setupUrl": {
+ "description": "HubSpot Play: the page where the customer connects HubSpot with OAuth.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "createLinks"
+ ],
+ "type": "object"
+}