Create Custom Event — API Reference

Method -: POST 

https://pagesense.zoho.com/pagesense/rest/v1/portal/{portal_name}/customevents

Scope required

PageSense.customevents.CREATE

Purpose / Description

Registers a project-scoped custom event that can be used as a conversion trigger by Goals or tracked via FullTracking. Custom events are lightweight identifiers you fire from your site/app (via SDK or tracking call) and reference in goals/experiments.

Request  

URL parameters  

portal_name — Portal identifier (path).

Field notes / validation 

  • customevent.event_name — string, required. Human-friendly event name. Keep it descriptive and unique within the project.

  • customevent.project_linkname — string, required. Project identifier; should match your project’s {linkname}.

Sample request:

Copiedcurl -X DELETE "https://pagesense.zoho.com/pagesense/rest/v1/portal/my-portal/customevents"  \
-H "Authorization: Zoho-oauthtoken {access_token}
-H "Content-Type: application/json" \
-d '{
	"customevent": {
		"event_name": "PremiumSignupCTA",
		"project_linkname": "saas-growth-project"
	}
 }'

Response field mapping 

  • customevents — array of created event objects.

  • event_id — canonical numeric ID for the custom event.

  • linkname — machine-safe version of the event name.

  • success — boolean confirming the operation.

Sample Response

Copied{
	"customevents": [
		{
			"event_id": 2000000027087,
			"success": true,
			"linkname": "premiumsignupcta"
		}]
}