POST https://restapi.actonsoftware.com/api/1/customevents/fact
This endpoint will upload a single custom event fact with a simple HTTP POST to the Fact API. Click here for more information on Custom Events.
Parameters
Name | Parameter Type |
Allow Multiple |
Required/ Optional |
Data Type | Description |
---|---|---|---|---|---|
Authorization: | Header | false | Required | String | Insert your generated access token. (Bearer {access token}) |
destination | form | false | Required | String |
Specify a unique name for the custom event. This is the name that displays in the UI (example: "Custom Touch Points") |
createlistingentry | form | false | Optional | String | Will create the destination if it doesn’t exist, if true. Endpoint will fail if false and destination doesn’t exist |
customeventaction | form | false | Required | String |
Set the event type of the custom event.
Note1:There can only be a single unigue custom event per csv file Note2:User friendly name can be defined in the UI This can be used in segmentation and scoring. For example: customeventaction = attended an event |
form | false | Required | String | Email address | |
when | form | false | Required | String | Date in format specified in DateFormat |
title | form | false | Required | String |
Title for the custom event in the source system. This can be used in segmentation and scoring. For example: Titlecolidx = Sample Custom Touch Point 123 |
note | form | false | Optional | String | Note for the custom event in the source system. Does not display in the UI. |
dateformat | form | false | Required | string | The date format used to parse the source file date column. |
dateformat Examples:
SLASH FORMATS: MM/dd/yyyy (01/25/2023) dd/MM/yyyy (25/01/2023) MM/dd/yy (01/25/2023) dd/MM/yy (01/25/23) yyyy/MM/dd (2023/01/25)
DASH FORMATS: MM-dd-yyyy (01-25-2023) dd-MM-yyyy (25-01-2023) MM-dd-yy (01-25-2023) dd-MM-yy (01-25-23) yyyy-MM-dd (2023-01-25)
TEXTUAL MONTH: dd MMM yyyy (25 Jan 2032) MMM dd yyyy (Jan 25 2023) dd MMMM yyyy (25 Jaunuary 2023) EEE, dd MMM yyyy (Tue, 25 Jan 2023) EEEE, dd MMMM yyyy (Tuesday, 25 January 2023)
{
"jobId": "15937380",
"status": "success"
}
Code Examples
cURL
curl -X POST https://restapi.actonsoftware.com/api/1/customevents/fact -H "Authorization: Bearer 12345678-9abc-defg-hijk-lmnopqrs" -H 'Cache-Control: no-cache' -H 'Content-Type: multipart/form-data' -H 'cache-control: no-cache' -H 'content-type: multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW' -F destination=TestCustomEvent -F dateformat=MM/dd/yyyy -F createlistingentry=N -F customeventaction=CUSTOM_GENERAL1 -F email=tester@test.com -F when=01/01/2023 -F title=title -F note=note