An experiment started

POST

The experiment as its start recorded it.

Request Body^required

Media typeapplication/json

WebhookEvent_WebhookExperiment_

object

api_version

Api Version

The payload version

string

default: v1

Allowed value: v1

created

required

Created

When the event happened

string format: date-time

data

required

WebhookData_WebhookExperiment_

The event’s object

object

object

required

WebhookExperiment

The topic’s object

object

arms

required

Arms

The arms in position order

Array<object>

WebhookExperimentArm

object

arm_id

required

Arm Id

The arm

string

/^arm_[0-9a-f]{32}$/

is_control

required

Is Control

True for the live version the test compares against

boolean

label

required

Label

The arm’s label

string

version_id

required

Version Id

The version the arm shows

string

/^ver_[0-9a-f]{32}$/

version_number

required

Version Number

That version’s number

integer

ended_at

required

Any of:

string

string format: date-time

null

null

experiment_id

required

Experiment Id

The experiment

string

/^expt_[0-9a-f]{32}$/

name

required

Name

Its name

string

outcome

required

Any of:

string

string

null

null

period

required

Period

The counting period the event closed or opened

integer

quiz_id

required

Quiz Id

Its quiz

string

/^quiz_[0-9a-f]{32}$/

started_at

required

Any of:

string

string format: date-time

null

null

status

required

Status

Its status as the lifecycle recorded it

string

Allowed values: running waiting ended

winner

required

Any of:

WebhookExperimentArm

WebhookExperimentArm

object

arm_id

required

Arm Id

The arm

string

/^arm_[0-9a-f]{32}$/

is_control

required

Is Control

True for the live version the test compares against

boolean

label

required

Label

The arm’s label

string

version_id

required

Version Id

The version the arm shows

string

/^ver_[0-9a-f]{32}$/

version_number

required

Version Number

That version’s number

integer

null

null

id

required

Id

The event id, also sent as the webhook-id header; deduplicate on it

string

/^evt_[0-9a-f]{32}$/

type

required

Type

The topic: quiz.started | quiz.finished | quiz.abandoned | identity.captured | quiz.published | experiment.started | experiment.ended | profile.created | profile.updated | export.completed | webhook.endpoint.disabled | ping

string

Responses

200

Any 2xx within 10 seconds acknowledges the event

4XX

410 ends the delivery and disables the endpoint; any other 4xx but 408 and 429 ends it

5XX

Retried, as are 408, 429, a timeout and a network error: seven retries over about 28 hours, then the delivery is dead