Skip to main content
POST
/
v0
/
event-configs
/
{eventConfigId}
/
generate-schema
Error
A valid request URL is required to generate request examples
{
  "name": "apppointment_request",
  "schema": {
    "type": "object",
    "properties": {
      "email": {
        "type": "string",
        "description": "The email address of the user."
      },
      "age": {
        "type": "number",
        "description": "The age of the user."
      }
    },
    "required": [
      "email"
    ],
    "additionalProperties": false
  },
  "strict": true
}

Authorizations

​
Authorization
string
header
required

Example: Bearer <YOUR_API_KEY>

Path Parameters

​
eventConfigId
string
required

Body

application/json

The context to generate the event config schema from.

​
context
string
required
Example:

"firstName: string, lastName: string, phoneNumber: string"

Response

​
name
string
required

The key of the EventConfig in snake_case

Example:

"apppointment_request"

​
schema
object
required
​
strict
boolean
required

Whether the schema is strict.

Example:

true