Skip to main 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

Request​

Path Parameters

    event_name Event Namerequired

    Event Params Schema event name

    sandbox_id uuidrequired

    Sandbox ID

Responses​

Successful Response

Schema

    custom_data

    object

    Custom data associated with the resource

    property name* string
    name Name (string)

    Possible values: non-empty and <= 125 characters

    Name of the resource

    description Description (string)

    Possible values: <= 250 characters

    Description of the resource

    last_modified_account_id uuid

    Account ID of the user who last modified the resource

    last_modified_timestamp date-time

    Timestamp of when the resource was last modified

    created_timestamp date-time

    Timestamp of when the resource was created

    event_name Event Name (string)required

    Name of the event, unique for sandbox_id

    value_jsonschema object

    Default value: [object Object]

    JSONSchema definition of the setting

    state State (string)

    Possible values: [enabled, disabled, deny]

    An enumeration.

Loading...