Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace SubmissionEventTypes

Index

Type aliases

Type aliases

ApprovalFormsInclusionConfiguration

ApprovalFormsInclusionConfiguration: { approvalFormsInclusion?: { value: "ALL" } | { approvalStepLabels: string[]; value: "PARTIAL" } }

Type declaration

  • Optional approvalFormsInclusion?: { value: "ALL" } | { approvalStepLabels: string[]; value: "PARTIAL" }

BPOINTSubmissionEvent

BPOINTSubmissionEvent: FormEventBase & { configuration: { crn2?: string; crn3?: string; elementId: string; environmentId: string }; type: "BPOINT" }

BaseFormSubmissionProcessing

BaseFormSubmissionProcessing: { bucketName: string; developerKey?: DeveloperKeyReference; externalId?: string; formId: number; formsAppEnvironmentId: number; formsAppId?: number; isDraft: boolean; key: string; keyId?: string; organisationId: string; submissionId: string; submissionTimestamp: string; timezone: string; user?: UserProfile } & S3SubmissionTags

BaseFreshdeskSubmissionEventFieldMapping

BaseFreshdeskSubmissionEventFieldMapping: { freshdeskFieldName: string }

Type declaration

  • freshdeskFieldName: string

CPHCMSSubmissionEvent

CPHCMSSubmissionEvent: FormEventBase & { configuration: PDFConfiguration & { categories?: { id: string; name: string }[]; contentTypeName: string; encryptPdf?: boolean; encryptedElementIds?: string[]; notificationElementId?: string; tags?: string[] }; type: "CP_HCMS" }

CPIntegrationHubWebhookSubmissionEvent

CPIntegrationHubWebhookSubmissionEvent: FormEventBase & { configuration: { formId?: number; url: string }; type: "CP_INTEGRATION_HUB_WEBHOOK" }

CPPaySubmissionEvent

CPPaySubmissionEvent: FormEventBase & { configuration: { elementId: string; gatewayId: string }; type: "CP_PAY" }

CallbackSubmissionEvent

CallbackSubmissionEvent: FormEventBase & EndpointConfigurationCallback

CivicRecCompleteCheckoutSubmissionEvent

CivicRecCompleteCheckoutSubmissionEvent: FormEventBase & { configuration: {}; type: "CIVIC_REC_COMPLETE_CHECKOUT" }

CivicaCrmSubmissionEvent

CivicaCrmSubmissionEvent: FormEventBase & { configuration: PDFConfiguration & { civicaCategory: CivicaRecord; civicaCustomerContactMethod: CivicaCustomerContactMethod; environmentId: string; mapping: CivicaCrmSubmissionEventMapping[] }; type: "CIVICA_CRM" }

CivicaCrmSubmissionEventMapping

CivicaCrmSubmissionEventMapping: { civicaCategoryItemNumber: number; formElementId: string; isDescription: boolean }

Type declaration

  • civicaCategoryItemNumber: number

    The item number of the civica category to map the OB form field to.

  • formElementId: string

    The elementId of the field to map to the civica category.

  • isDescription: boolean

CivicaCustomerContactMethod

CivicaCustomerContactMethod: { code: string; description: string }

Type declaration

  • code: string
  • description: string

CivicaRecord

CivicaRecord: { id: number; label: string }

Type declaration

  • id: number
  • label: string

EmailConfiguration

EmailConfiguration: ApprovalFormsInclusionConfiguration & { bccEmail?: string[]; ccEmail?: string[]; email?: string; emailAttachmentsEndpoint?: EndpointConfiguration; emailSubjectLine?: string; emailTemplate?: { id: number; mapping: PdfSubmissionEventEmailTemplateMapping[] }; excludedAttachmentElementIds?: string[]; toEmail?: string[] }

EmailOnlySubmissionEvent

EmailOnlySubmissionEvent: FormEventBase & { configuration: EmailConfiguration; type: "EMAIL" }

FormElementMapping

FormElementMapping<T>: T & ({ formElementId: string; mapping: FormElementMapping<T>; type: "FORM_FORM_ELEMENT" } | { formElementId: string; type: "FORM_ELEMENT" } | { type: "VALUE"; value: number | string | boolean | string[] } | { type: "SUBMISSION_ID" } | { type: "EXTERNAL_ID" })

Type parameters

  • T

FormEvent

FormEvent: FormPaymentEvent | FormSchedulingEvent | FormWorkflowEvent

FormEventBase

FormEventBase: FormEventConditional & { isRetryable?: boolean; label?: string }

FormEventConditional

FormEventConditional: { conditionallyExecute?: boolean; conditionallyExecutePredicates?: ConditionalPredicate[]; requiresAllConditionallyExecutePredicates?: boolean }

Type declaration

  • Optional conditionallyExecute?: boolean

    Whether the submission event should be conditionally executed.

  • Optional conditionallyExecutePredicates?: ConditionalPredicate[]

    Array of the conditional predicates.

  • Optional requiresAllConditionallyExecutePredicates?: boolean

    Whether the conditional execution requires all predicates to be true as opposed to one.

FormEventType

FormEventType: FormEvent["type"]

FormPaymentEvent

FormPaymentEvent: CPPaySubmissionEvent | BPOINTSubmissionEvent | WestpacQuickStreamSubmissionEvent | NSWGovPaySubmissionEvent

FormPaymentEventType

FormPaymentEventType: FormPaymentEvent["type"]

FormSchedulingEvent

FormSchedulingEvent: NylasSubmissionEvent

FormSchedulingEventType

FormSchedulingEventType: FormSchedulingEvent["type"]

FormSubmissionProcessing

FormSubmissionProcessing<T>: FormSubmissionProcessingEvent<T> | FormSubmissionProcessingFormStore

Type parameters

  • T = undefined

FormSubmissionProcessingEvent

FormSubmissionProcessingEvent<T>: BaseFormSubmissionProcessing & { attempt: number; delayInSeconds: number; formSubmissionWorkflowEventId: number; maxAttempts: number; submissionEvent: T; type: "EVENT" }

Type parameters

  • T

FormSubmissionProcessingFormStore

FormSubmissionProcessingFormStore: BaseFormSubmissionProcessing & { type: "FORM_STORE" }

FormWorkflowEvent

FormWorkflowEvent: CallbackSubmissionEvent | PowerAutomateFlowSubmissionEvent | CPIntegrationHubWebhookSubmissionEvent | PdfSubmissionEvent | OneBlinkAPISubmissionEvent | TrimSubmissionEvent | CPHCMSSubmissionEvent | CivicaCrmSubmissionEvent | EmailOnlySubmissionEvent | FreshdeskCreateTicketSubmissionEvent | FreshdeskAddNoteToTicketSubmissionEvent | SharepointCreateListItemSubmissionEvent | SharepointStoreFilesSubmissionEvent | CivicRecCompleteCheckoutSubmissionEvent

FormWorkflowEventType

FormWorkflowEventType: FormWorkflowEvent["type"]

FreshdeskAddNoteToTicketSubmissionEvent

FreshdeskAddNoteToTicketSubmissionEvent: FormEventBase & { configuration: ApprovalFormsInclusionConfiguration; type: "FRESHDESK_ADD_NOTE_TO_TICKET" }

FreshdeskCreateTicketSubmissionEvent

FreshdeskCreateTicketSubmissionEvent: FormEventBase & { configuration: ApprovalFormsInclusionConfiguration & { mapping: FreshdeskSubmissionEventFieldMapping[] }; type: "FRESHDESK_CREATE_TICKET" }

FreshdeskSubmissionEventFieldMapping

FreshdeskSubmissionEventFieldMapping: FormElementMapping<BaseFreshdeskSubmissionEventFieldMapping> | (BaseFreshdeskSubmissionEventFieldMapping & { dependentFieldValue: { category: string; item: string; subCategory: string }; type: "DEPENDENT_FIELD_VALUE" })

NSWGovPaySubmissionEvent

NSWGovPaySubmissionEvent: FormEventBase & { configuration: { customerReference?: string; elementId: string; primaryAgencyId: string; productDescription: string; subAgencyCode?: string }; type: "NSW_GOV_PAY" }

NewWebhookSubscription

NewWebhookSubscription: { callbackUrl: string; formId?: number; keyId: string; label?: string; organisationId: string; trigger?: "AFTER_SUBMISSION" | "AFTER_APPROVAL" }

Type declaration

  • callbackUrl: string
  • Optional formId?: number
  • keyId: string
  • Optional label?: string
  • organisationId: string
  • Optional trigger?: "AFTER_SUBMISSION" | "AFTER_APPROVAL"

NylasSubmissionEvent

NylasSubmissionEvent: FormEventBase & { configuration: PDFConfiguration & { emailDescription?: string; emailElementId?: string; nameElementId?: string; nylasConfigurationId: string; nylasGrantId: string }; type: "NYLAS" }

OneBlinkAPISubmissionEvent

OneBlinkAPISubmissionEvent: FormEventBase & EndpointConfigurationAPI

PDFConfiguration

PDFConfiguration: ApprovalFormsInclusionConfiguration & { customPdfId?: string; excludedCSSClasses?: string[]; excludedElementIds?: string[]; includeCalendarBookingInPdf?: boolean; includeExternalIdInPdf?: boolean; includePaymentInPdf?: boolean; includeSubmissionIdInPdf?: boolean; isCustomPdfEditable?: boolean; pdfFileName?: string; pdfSize?: FormSubmissionPDFPageSize; usePagesAsBreaks?: boolean }

PdfSubmissionEvent

PdfSubmissionEvent: FormEventBase & { configuration: PDFConfiguration & EmailConfiguration; type: "PDF" }

PdfSubmissionEventEmailTemplateMapping

PdfSubmissionEventEmailTemplateMapping: { mustacheTag: string } & ({ formElementId: string; type: "FORM_ELEMENT" } | { text: string; type: "TEXT" })

PowerAutomateFlowSubmissionEvent

PowerAutomateFlowSubmissionEvent: FormEventBase & { configuration: { formId?: number; url: string }; type: "POWER_AUTOMATE_FLOW" }

S3SubmissionTags

S3SubmissionTags: { externalId?: string; jobId?: string; previousFormSubmissionApprovalId?: string; userToken?: string }

Type declaration

  • Optional externalId?: string
    deprecated

    No longer stored as an S3 tag. It is now stored in the S3 object JSON data.

  • Optional jobId?: string
  • Optional previousFormSubmissionApprovalId?: string
  • Optional userToken?: string
    deprecated

    username should be stored as a claim in token instead of using userToken when submitting forms using a developer key.

SharepointColumnResourceDefinitionBase

SharepointColumnResourceDefinitionBase: { sharepointColumnDefinitionName: string }

Type declaration

  • sharepointColumnDefinitionName: string

    The API-facing name of the column. Use this in the fields property when creating the list item.

SharepointCreateListItemSubmissionEvent

SharepointCreateListItemSubmissionEvent: FormEventBase & { configuration: SharepointSubmissionEventBase & { mapping: SharepointCreateListItemSubmissionEventMapping[]; sharepointList: { displayName: string; id: string } }; type: "SHAREPOINT_CREATE_LIST_ITEM" }

SharepointCreateListItemSubmissionEventMapping

SharepointCreateListItemSubmissionEventMapping: FormElementMapping<SharepointColumnResourceDefinitionBase>

SharepointStoreFilesSubmissionEvent

SharepointStoreFilesSubmissionEvent: FormEventBase & { configuration: PDFConfiguration & SharepointSubmissionEventBase & { excludeAttachments: boolean; folderPath?: string; sharepointDrive: { displayName: string; id: string } }; type: "SHAREPOINT_STORE_FILES" }

SharepointSubmissionEventBase

SharepointSubmissionEventBase: { integrationEntraApplicationId: string; sharepointSite: { displayName: string; id: string } }

Type declaration

  • integrationEntraApplicationId: string

    The id of the entra application in integration configuration

  • sharepointSite: { displayName: string; id: string }

    The Sharepoint Site

    • displayName: string

      The display name of the Sharepoint Site

    • id: string

      The id of the Sharepoint Site

TrimSubmissionEvent

TrimSubmissionEvent: FormEventBase & { configuration: PDFConfiguration & { actionDefinition?: TrimUriOption; author?: TrimUriOption; container: TrimUriOption; environmentId: string; groupFiles?: boolean; location?: TrimUriOption; recordTitle?: string; recordType: TrimUriOption }; type: "TRIM" }

TrimUriOption

TrimUriOption: { label: string; uri: number }

Type declaration

  • label: string

    The attribute label.

  • uri: number

    The attribute uri.

WebhookSubmissionEventPayload

WebhookSubmissionEventPayload: { externalId?: string; formId: number; formsAppId?: number; isDraft: boolean; jobId?: string; secret?: string; submissionId: string; submissionTimestamp: string; userToken?: string; username?: string }

Type declaration

  • Optional externalId?: string
  • formId: number
  • Optional formsAppId?: number
  • isDraft: boolean
  • Optional jobId?: string
  • Optional secret?: string
  • submissionId: string
  • submissionTimestamp: string
  • Optional userToken?: string
  • Optional username?: string

WebhookSubscription

WebhookSubscription: NewWebhookSubscription & { createdAt: string; id: number }

WestpacQuickStreamSubmissionEvent

WestpacQuickStreamSubmissionEvent: FormEventBase & { configuration: { customerReferenceNumber: string; elementId: string; environmentId: string }; type: "WESTPAC_QUICK_STREAM" }