Skip to main content

Function: eventActionConfigService()

eventActionConfigService(client): object

Defined in: service/EventActionConfigService.ts:29

Service for managing event action configurations

Parameters​

client​

GraphQLClient

Returns​

createEventToEmailConfig()​

createEventToEmailConfig(input): Promise<EventToEmailConfig>

Creates a new event to email configuration *

Parameters​

input​

EventToEmailConfigCreateInput

EventToEmailConfig creation input data *

Returns​

Promise<EventToEmailConfig>

Promise<EventToEmailConfig> The created event-to-email config

createEventToWebHookConfig()​

createEventToWebHookConfig(input): Promise&lt;EventToWebHookConfig>

Creates a new event to webhook configuration *

Parameters​

input​

EventToWebHookConfigCreateInput

EventToWebHookConfig creation input data *

Returns​

Promise&lt;EventToWebHookConfig>

Promise<EventToWebHookConfig> The created event-to-webhook config

getEventActionConfig()​

getEventActionConfig(id): Promise&lt;IEventActionConfig>

Retrieves a specific event action configuration *

Parameters​

id​

number

Event action config ID *

Returns​

Promise&lt;IEventActionConfig>

Promise<IEventActionConfig> Event action configuration data

getEventActionConfigs()​

getEventActionConfigs(input?): Promise&lt;EventActionConfigResponse>

Retrieves event action configurations with optional search *

Parameters​

input?​

EventActionConfigSearchInput

Search input parameters *

Returns​

Promise&lt;EventActionConfigResponse>

Promise<EventActionConfigResponse> The event action configurations response

publishEmailEvent()​

publishEmailEvent(input): Promise&lt;PublishEmailEventResponse>

Publishes an email event *

Parameters​

input​

EmailEventInput

Email event input data *

Returns​

Promise&lt;PublishEmailEventResponse>

Promise<PublishEmailEventResponse> The publish response

publishEmailSendEvent()​

publishEmailSendEvent(input): Promise&lt;PublishEmailEventResponse>

Publishes an email send event *

Parameters​

input​

EmailSendEventInput

Email send event input data *

Returns​

Promise&lt;PublishEmailEventResponse>

Promise<PublishEmailEventResponse> The publish response

publishPasswordResetEmailEvent()​

publishPasswordResetEmailEvent(input): Promise&lt;PublishEmailEventResponse>

Publishes a password reset email event *

Parameters​

input​

PasswordResetLinkEmailInput

Password reset email event input data *

Returns​

Promise&lt;PublishEmailEventResponse>

Promise<PublishEmailEventResponse> The publish response

Deprecated​

Use triggerPasswordSendResetEmailEvent (via UserService.sendPasswordResetEmail) which routes through the event-action-manager + template-engine instead. *

updateEventToEmailConfig()​

updateEventToEmailConfig(variables): Promise&lt;EventToEmailConfig>

Updates an existing event to email configuration *

Parameters​

variables​

EventToEmailConfigUpdateVariables

EventToEmailConfig update input data *

Returns​

Promise&lt;EventToEmailConfig>

Promise<EventToEmailConfig> The updated event-to-email config

updateEventToWebHookConfig()​

updateEventToWebHookConfig(variables): Promise&lt;EventToWebHookConfig>

Updates an existing event to webhook configuration *

Parameters​

variables​

EventToWebHookConfigUpdateVariables

EventToWebHookConfig update input data *

Returns​

Promise&lt;EventToWebHookConfig>

Promise<EventToWebHookConfig> The updated event-to-webhook config