Create a Custom Event

1 min

POST

https://api.optimizely.com/v2/projects/{project_id}/custom_events

Create a Custom Event in a provided Project

Path Parameters

project_idinteger<int64>required
Description
The Project ID of the Project you want to create an Custom Event in
Format
int64

Body Parameters

bodyCustomEventrequired
Description
A string in JSON format that includes all the fields to create a Custom Event
- archivedboolean
  Description
  Whether or not to archive this Event
- categoryEventCategories
  - namestring
- descriptionstring
  Description
  A description of this Event
- event_propertiesEventProperty[]
  Description
  A set of user-defined data elements for the event. Metrics can filter on particular values of these properties.
  - data_typestring<boolean | number | string>
    Description
    The type of data that can be accepted for this property.
    Allowed
    booleannumberstring
  - namestring
    Description
    The name of the property.
- event_typestring<custom>
  Description
  The type of this Event
  Allowed
  custom
- keystringrequired
  Example
  loaded_new_app
  Description
  Unique string identifier for this Event within the Project
  Max Length
  64
  Pattern
  ^[a-zA-Z0-9_\- .]+$
- namestring
  Example
  Loaded New App
  Description
  A human readable name for this Event. If unspecified, defaults to the key

Responses

201Return the created Custom Event

CustomEvent
- archivedboolean
  Description
  Whether or not to archive this Event
- categoryEventCategories
  - namestring
- createdstring<date-time>
  Description
  Creation date for this Event
  Format
  date-time
- descriptionstring
  Description
  A description of this Event
- event_propertiesEventProperty[]
  Description
  A set of user-defined data elements for the event. Metrics can filter on particular values of these properties.
  - data_typestring<boolean | number | string>
    Description
    The type of data that can be accepted for this property.
    Allowed
    booleannumberstring
  - namestring
    Description
    The name of the property.
- event_typestring<custom>
  Description
  The type of this Event
  Allowed
  custom
- idinteger<int64>
  Description
  The unique identifier of the Event
  Format
  int64
- is_classicboolean
  Description
  Whether or not this Event is a classic Event. If true, this Event is read-only
  Default
  false
- is_editableboolean
  Description
  Whether or not this Event may be edited
- keystringrequired
  Example
  loaded_new_app
  Description
  Unique string identifier for this Event within the Project
  Max Length
  64
  Pattern
  ^[a-zA-Z0-9_\- .]+$
- namestring
  Example
  Loaded New App
  Description
  A human readable name for this Event. If unspecified, defaults to the key
- project_idinteger<int64>
  Example
  1000
  Description
  The ID of this Event's parent Project
  Format
  int64

400Invalid request body supplied

Error
- codestring
- messagestring
- messagesobject
- uuidstring<uuid>
  Format
  uuid

401Invalid credentials

Error
- codestring
- messagestring
- messagesobject
- uuidstring<uuid>
  Format
  uuid

403You do not have access to the specified Project

Error
- codestring
- messagestring
- messagesobject
- uuidstring<uuid>
  Format
  uuid

defaultUnexpected error

Error
- codestring
- messagestring
- messagesobject
- uuidstring<uuid>
  Format
  uuid

curl

curl --request POST \
     --url https://api.optimizely.com/v2/projects/{project_id}/custom_events \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '{
     "key": "loaded_new_app"
     }'

javascript

var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");

var raw = JSON.stringify({
   "key": "loaded_new_app"
});

var requestOptions = {
   method: 'POST',
   headers: myHeaders,
   body: raw,
   redirect: 'follow'
};

fetch("https://api.optimizely.com/v2/projects/{project_id}/custom_events", requestOptions)
   .then(response => response.text())
   .then(result => console.log(result))
   .catch(error => console.log('error', error));

ruby

require "uri"
require "json"
require "net/http"

url = URI("https://api.optimizely.com/v2/projects/{project_id}/custom_events")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Post.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"
request.body = JSON.dump({
   "key": "loaded_new_app"
})

response = https.request(request)
puts response.read_body

python

import requests
import json

url = "https://api.optimizely.com/v2/projects/{project_id}/custom_events"

payload = json.dumps({
   "key": "loaded_new_app"
})
headers = {
   'accept': 'application/json',
   'content-type': 'application/json'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)

201

// Return the created Custom Event
{
  "archived": false,
  "category": "",
  "created": "",
  "description": "",
  "event_properties": [
    {
      "data_type": "",
      "name": ""
    }
  ],
  "event_type": "",
  "id": "",
  "is_classic": false,
  "is_editable": false,
  "key": "loaded_new_app",
  "name": "Loaded New App",
  "project_id": 1000
}

400

// Invalid request body supplied
{
  "code": "",
  "message": "",
  "messages": {},
  "uuid": ""
}

401

// Invalid credentials
{
  "code": "",
  "message": "",
  "messages": {},
  "uuid": ""
}

403

// You do not have access to the specified Project
{
  "code": "",
  "message": "",
  "messages": {},
  "uuid": ""
}

default

// Unexpected error
{
  "code": "",
  "message": "",
  "messages": {},
  "uuid": ""
}