Activation data model

Updated:

View field support, webhooks, and list parameters for each integration on the Supported Integrations page.

FieldTypeRequiredDescription
idstringNoUnique identifier for this activation object
created_atstring (date-time)NoThe date that this activation object was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
updated_atstring (date-time)NoThe last date that this activation object was updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
namestringNoThe name of the activation/sync job
segment_idstringNoThe cdp_segment being activated; points to CdpSegment
destination_idstringNoThe cdp_destination the data is sent to; points to CdpDestination
source_idstringNoThe cdp_source the data originates from; points to CdpSource
schedulestringNoThe activation schedule or mode (eg. cron, interval, realtime, batch)
statusenumNoThe current status of the activation Values: ACTIVE, PAUSED, ERROR, PENDING
last_run_atstring (date-time)NoWhen the activation last ran (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
is_enabledbooleanNoWhether the activation is active/enabled
metadataCdpMetadata[]No
metadata[].idstringNo
metadata[].slugstringNoThe attribute/trait key (eg. lifetime_value)
metadata[].valueobjectNoThe attribute/trait value
metadata[].namespacestringNoThe scope or origin of the attribute (eg. computed, event, visitor)
metadata[].formatenumNoThe data type of the attribute value Values: TEXT, NUMBER, DATE, BOOLEAN, ARRAY, OBJECT
metadata[].extra_dataobjectNo

TypeScript

TypeScript
export type CdpActivation = {
	id?: string; // Unique identifier for this activation object
	created_at?: string-time; // The date that this activation object was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	updated_at?: string-time; // The last date that this activation object was updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	name?: string; // The name of the activation/sync job
	segment_id?: string; // The cdp_segment being activated; points to CdpSegment
	destination_id?: string; // The cdp_destination the data is sent to; points to CdpDestination
	source_id?: string; // The cdp_source the data originates from; points to CdpSource
	schedule?: string; // The activation schedule or mode (eg. cron, interval, realtime, batch)
	status?: 'ACTIVE' | 'PAUSED' | 'ERROR' | 'PENDING'; // The current status of the activation
	last_run_at?: string-time; // When the activation last ran (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	is_enabled?: boolean; // Whether the activation is active/enabled
	metadata?: [];
	raw?: any; // The raw data returned by the integration for this activation
} 

Zod

Zod
import { z } from 'zod';

export const ZodCdpActivation = z.object({
	id: z.string().optional().describe("Unique identifier for this activation object"),
	created_at: z.string-time().optional().describe("The date that this activation object was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	updated_at: z.string-time().optional().describe("The last date that this activation object was updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	name: z.string().optional().describe("The name of the activation/sync job"),
	segment_id: z.string().optional().describe("The cdp_segment being activated; points to CdpSegment"),
	destination_id: z.string().optional().describe("The cdp_destination the data is sent to; points to CdpDestination"),
	source_id: z.string().optional().describe("The cdp_source the data originates from; points to CdpSource"),
	schedule: z.string().optional().describe("The activation schedule or mode (eg. cron, interval, realtime, batch)"),
	status: z.enum("ACTIVE", "PAUSED", "ERROR", "PENDING").optional().describe("The current status of the activation"),
	last_run_at: z.string-time().optional().describe("When the activation last ran (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	is_enabled: z.boolean().optional().describe("Whether the activation is active/enabled"),
	metadata: z.array().optional(),

});

Python

Python
import dataclasses

@dataclasses.dataclass
class CdpActivationStatus(str, Enum):
	ACTIVE = 'ACTIVE'
	PAUSED = 'PAUSED'
	ERROR = 'ERROR'
	PENDING = 'PENDING'

@dataclasses.dataclass
class CdpActivation:
	"""Unique identifier for this activation object"""
	id: Optional[str]
	"""The date that this activation object was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	created_at: Optional[str]
	"""The last date that this activation object was updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	updated_at: Optional[str]
	"""The name of the activation/sync job"""
	name: Optional[str]
	"""The cdp_segment being activated; points to CdpSegment"""
	segment_id: Optional[str]
	"""The cdp_destination the data is sent to; points to CdpDestination"""
	destination_id: Optional[str]
	"""The cdp_source the data originates from; points to CdpSource"""
	source_id: Optional[str]
	"""The activation schedule or mode (eg. cron, interval, realtime, batch)"""
	schedule: Optional[str]
	"""The current status of the activation"""
	status: Optional[CdpActivationStatus]
	"""When the activation last ran (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	last_run_at: Optional[str]
	"""Whether the activation is active/enabled"""
	is_enabled: Optional[bool]
	metadata: Optional[PropertyCdpActivationMetadata]
Are we missing anything? Let us know
Was this page helpful?