Skip to main content

triggerCustomEvent

Execute custom event actions with dynamic payload data.

Triggers all event action configurations that match the provided custom event code. The payload data is passed to each matching configuration for processing, enabling flexible business automation workflows.

Possible errors:

  • TRIGGER_CUSTOM_EVENT_ERROR: Failed to trigger the custom event
  • EVENT_ACTION_CONFIG_NOT_FOUND: Event action configuration not found for the specified code
  • TRIGGER_SEND_EMAIL_EVENT_ERROR: Failed to send email for email action configurations
  • TRIGGER_POST_TO_WEBHOOK_EVENT_ERROR: Failed to post to webhook for webhook action configurations
triggerCustomEvent(
  input: TriggerCustomEventInput!
): Boolean!

Arguments​

triggerCustomEvent.input ● TriggerCustomEventInput! non-null input​

Custom event trigger data including code and payload information.

Type​

Boolean scalar​

The Boolean scalar type represents true or false.