Module: notification_event

Copyright 2020 Parsable, Inc

Schema definition for 'Applet' configurations.

Module	Services	Data types	Constants
notification_event		Email Hub InputType IntegrationResponse NotificationEvent NotificationOp Phone PhoneMessage Push ResponsePath Webhook

Enumerations

Enumeration: InputType

`STRING`	`1`
`INTEGER`	`2`

Data structures

Struct: Hub

Key	Field	Type	Description	Requiredness	Default value
1	userId	`string`		required
2	header	`string`		default
3	body	`string`		default
4	footer	`string`		default

Struct: Push

Key	Field	Type	Description	Requiredness	Default value
1	userId	`string`		required
2	pushVendor	`string`		optional
3	pushToken	`string`		optional
4	text	`string`		required
5	payload	`map<string, string>`		optional

Struct: Email

Key	Field	Type	Description	Requiredness	Default value
1	to	`string`		required
2	toName	`string`		optional
3	subject	`string`		required
4	body	`string`		required
5	locale	`string`		optional

Union: PhoneMessage

Key	Field	Type	Description	Requiredness	Default value
1	SMS	`string`		default
2	Voice	`string`		default

Struct: Phone

Key	Field	Type	Description	Requiredness	Default value
1	countryCode	`string`		required
2	phoneNumber	`string`		required
3	message	`PhoneMessage`		required

Struct: ResponsePath

Key	Field	Type	Description	Requiredness	Default value
1	path	`string`		default
2	name	`string`		default
3	inputType	`InputType`		default

Struct: Webhook

Key	Field	Type	Description	Requiredness	Default value
1	url	`string`		default
2	method	`string`		default
3	headers	`map<string, string>`		default
4	payload	`string`		default
5	responsePaths	`list<ResponsePath>`		default

Union: NotificationOp

Key	Field	Type	Description	Requiredness	Default value
1	hub	`Hub`		default
2	push	`Push`		default
3	email	`Email`		default
4	phone	`Phone`		default
5	webhook	`Webhook`		default

Struct: NotificationEvent

Key	Field	Type	Description	Requiredness	Default value
1	pedigree	`core_event.Pedigree`		required
3	op	`NotificationOp`		required
100	jobId	`string`		default
101	jobBaseStepId	`string`		default
102	fieldId	`string`		default

Struct: IntegrationResponse

Key	Field	Type	Description	Requiredness	Default value
1	baseEvent	`NotificationEvent`		default
2	statusCode	`i32`		default
3	responseBytes	`string`		default