Search
K
notifications v2

EmailNotificationRegistrationRequest

object
notificationTypestringrequired

The type of notification

Match pattern:^(WEBHOOK|EMAIL)$

Example:WEBHOOK

eventTypesarray[string]required

Through this field, Integrators have the ability to subscribe to a variety of notification types based on their preferences.

Note: A registration must be created with at least one preferred event type and all mandatory event types for successful registration. An email registration can be updated to contain an empty list of event types. A webhook registration must always contain at least one preferred event type and all mandatory event types.

Preferred Webhook Events

  • WORKSPACE_PARTICIPANT_ADDED
  • FINANCIAL_SETTLEMENT_SCHEDULE_PREPARED
  • LODGEMENT_CASE_PREPARED
  • WORKSPACE_PREPARED
  • WORKSPACE_FUNDS_AUTHORISED
  • WORKSPACE_FUNDS_EXCHANGED
  • WORKSPACE_LODGED
  • WORKSPACE_CLOSED
  • WORKSPACE_REQUISITIONED
  • WORKSPACE_CANCELLED
  • WORKSPACE_REVERTED_TO_CREATED
  • TITLE_DATA_RECEIVED
  • TITLE_SEARCH_PENDING
  • TITLE_NOT_FOUND

    • Preferred Email Events
  • LODGEMENT_CASE_REQUISITIONED
  • NETTING_COMPLETED

    • Mandatory Webhook Events
  • SECRET_EXPIRY

    • attributesobjectrequired
    Show Child Parameters
    Example

    EmailAttribute

    object
    emailstring(email)required

    The email address of the subscriber

    Example:subscriber@example.com

    Example

    WebhookNotificationRegistrationRequest

    object
    notificationTypestringrequired

    The type of notification

    Match pattern:^(WEBHOOK|EMAIL)$

    Example:WEBHOOK

    eventTypesarray[string]required

    Through this field, Integrators have the ability to subscribe to a variety of notification types based on their preferences.

    Note: A registration must be created with at least one preferred event type and all mandatory event types for successful registration. An email registration can be updated to contain an empty list of event types. A webhook registration must always contain at least one preferred event type and all mandatory event types.

    Preferred Webhook Events

  • WORKSPACE_PARTICIPANT_ADDED
  • FINANCIAL_SETTLEMENT_SCHEDULE_PREPARED
  • LODGEMENT_CASE_PREPARED
  • WORKSPACE_PREPARED
  • WORKSPACE_FUNDS_AUTHORISED
  • WORKSPACE_FUNDS_EXCHANGED
  • WORKSPACE_LODGED
  • WORKSPACE_CLOSED
  • WORKSPACE_REQUISITIONED
  • WORKSPACE_CANCELLED
  • WORKSPACE_REVERTED_TO_CREATED
  • TITLE_DATA_RECEIVED
  • TITLE_SEARCH_PENDING
  • TITLE_NOT_FOUND

    • Preferred Email Events
  • LODGEMENT_CASE_REQUISITIONED
  • NETTING_COMPLETED

    • Mandatory Webhook Events
  • SECRET_EXPIRY

    • attributesobjectrequired
    Show Child Parameters
    Example

    WebhookURIAttribute

    object
    webhookURIstring(uri)required

    The webhook URL

    Example:https://example.com/webhook

    Example

    NotificationType

    string

    The type of notification

    Match pattern:^(WEBHOOK|EMAIL)$

    Example