Channel data model

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

FieldTypeRequiredDescription
idstringNo
created_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
updated_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
namestringNo
descriptionstringNo
parent_idstringNo
has_subchannelsbooleanNo
membersMessagingMember[]No
members[].user_idstringNo(reference to HrisEmployee)
members[].emailstringNo
members[].namestringNo
members[].image_urlstringNo
is_activebooleanNo
is_privatebooleanNo
web_urlstringNo

TypeScript

TypeScript
export type MessagingChannel = {
	id?: string;
	created_at?: string-time; // (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	updated_at?: string-time; // (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	name?: string;
	description?: string;
	parent_id?: string;
	has_subchannels?: boolean;
	members?: [];
	is_active?: boolean;
	is_private?: boolean;
	web_url?: string;
	raw?: any;
} 

Zod

Zod
import { z } from 'zod';

export const ZodMessagingChannel = z.object({
	id: z.string().optional(),
	created_at: z.string-time().optional().describe("(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	updated_at: z.string-time().optional().describe("(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	name: z.string().optional(),
	description: z.string().optional(),
	parent_id: z.string().optional(),
	has_subchannels: z.boolean().optional(),
	members: z.array().optional(),
	is_active: z.boolean().optional(),
	is_private: z.boolean().optional(),
	web_url: z.string().optional(),

});

Python

Python
import dataclasses

@dataclasses.dataclass
class MessagingChannel:
	id: Optional[str]
	"""(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	created_at: Optional[str]
	"""(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	updated_at: Optional[str]
	name: Optional[str]
	description: Optional[str]
	parent_id: Optional[str]
	has_subchannels: Optional[bool]
	members: Optional[PropertyMessagingChannelMembers]
	is_active: Optional[bool]
	is_private: Optional[bool]
	web_url: Optional[str]
Are we missing anything? Let us know
Was this page helpful?