Skip to content

Get Event Params Schema For Sandbox

GET
/v1/sandbox/{sandbox_id}/event-params-schema/{event_name}

Get Custom Event Params Schema definition by event_name, requires sandbox:config:view permission

Authorizations

Parameters

Path Parameters

event_name
required

Event Params Schema event name

string

Event Params Schema event name

sandbox_id
required

Sandbox ID

string format: uuid

Sandbox ID

Responses

200

Successful Response

This mixin is meant to give a set of common properties to root config models

object
custom_data

Custom data associated with the resource

object
key
additional properties
string
name

Name of the resource

string
>= 1 characters <= 125 characters
description

Description of the resource

string
>= 1 characters <= 250 characters
last_modified_account_id

Account ID of the user who last modified the resource

string format: uuid
last_modified_timestamp

Timestamp of when the resource was last modified

string format: date-time
created_timestamp

Timestamp of when the resource was created

string format: date-time
event_name
required

Name of the event, unique for sandbox_id

string
value_jsonschema

JSONSchema definition of the setting

object
state

Indicate the state of the schema, enabled, disabled or deny

string
default: enabled

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string