Skip to main content

Introduction

Introduction​

The Event Action Manager module is a centralized tool designed to easily subscribe to events that happen within the Platform to perform a certain action with the event's payload. With this module it is possible to execute multiple actions on the same event.

Currently we support 2 actions to be performed: SEND_EMAIL & POST_TO_WEBHOOK.

SEND_EMAIL​

This triggers the Template Management Module to render an template with the Event payload and send it as e-mail.

POST_TO_WEBHOOK​

Posts the event payload to a WebHook.

Supported events ​

Event NameDescriptionPayload
ORDER_CREATEDEvent triggered when a new order or quote is created.Order
ORDER_UPDATEDEvent triggered when an existing order or quote is updated.Order
ORDER_DELETEDEvent triggered when an existing order or quote is deleted.Only orderId
ORDER_SEND_CONFIRMATIONEvent triggered for sending a regular order confirmation e-mail, used in the checkout process of a customer or contact in the front-end, as well as the 'Send order to client' button in Propeller Sales Portal.Order
QUOTE_SENDEvent triggered to send a quote proposal to the contact, triggered by the 'Send to client' button in Propeller Sales Portal.Order
QUOTE_SEND_REQUESTEvent triggered to send the confirmation e-mail after a quote is requested by a customer from the front-end.Order
QUOTE_SEND_VALIDATIONEvent triggered to send a quote to a senior account manager or sales manager for validation purposes.Order
CONTACT_SEND_WELCOME_EMAILEvent triggered to send a welcome e-mail to a new contact.Contact
CUSTOMER_SEND_WELCOME_EMAILEvent triggered to send a welcome e-mail to a new customer.Customer
SEND_RESET_PASSWORDEvent triggered to send a password reset e-mail to a contact or customer.PasswordRedirect
SEND_INIT_PASSWORDEvent triggered to send a initial set password e-mail to a contact or customer.PasswordRedirect
CUSTOM_EVENTUsed to trigger an event with a custom payloadCustomPayload

Event payloads​

Below we'll list an example for each of the type of event.

Order​

{ 
    "order": {
        "id": 1,
        "userId": 14644,
        "accountManagerId": null,
        "cartId": "01941780-c402-79ac-bade-0e9e37eb65c1",
        "channelId": 1,
        "shopId": 1,
        "uuid": "01941781-1cb2-7993-bb33-60ed9da34d64",
        "externalId": null,
        "debtorId": "ANONYMOUS",
        "status": "NEW",
        "type": "dropshipment",
        "source": "webshop",
        "email": "noreply@propel.us",
        "emailDate": null,
        "remarks": null,
        "extra3": null,
        "extra4": null,
        "currency": "EUR",
        "currencyRatio": "1.00000",
        "language": "NL",
        "date": "2024-12-30T12:18:45.000Z",
        "statusDate": "2024-12-30T12:18:45.000Z",
        "postageData": {
        "method": "DELIVERY",
        "taxPercentage": "0.00",
        "requestDate": "2024-12-30T12:18:22.000Z",
        "gross": "2000.00000",
        "net": "2000.00000",
        "tax": 0,
        "partialDeliveryAllowed": "N",
        "pickUpLocationId": 0,
        "overruled": "Y",
        "carrier": "Mark delivery company"
        },
        "paymentData": {
            "net": "0.00000",
            "gross": "0.00000",
            "tax": "0.00000",
            "taxPercentage": "0.00",
            "method": "ACCOUNT",
            "status": "UNKNOWN",
            "statusDate": null,
            "overruled": "N",
            "accountingId": null
        },
        "total": {
            "gross": "2050.00000",
            "net": "2050.00000",
            "tax": "0.00000",
            "discountValue": "0.00000",
            "discountType": "N",
            "taxPercentages": []
        },
        "items": [
            {
                "id": 1,
                "uuid": "01941780-df79-75a3-83a5-b851ac114c0c",
                "class": "product",
                "productId": 1,
                "parentOrderItemId": null,
                "quantity": 1,
                "sku": "NCABD70004",
                "notes": null,
                "name": "Edge 1030 FietsComputer",
                "supplier": "TECHDATA",
                "supplierCode": "NCABD70004",
                "manufacturer": "Lavazza",
                "manufacturerCode": "NCABD70004",
                "eanCode": null,
                "originalPrice": "55.00000",
                "price": "50.00000",
                "priceTotal": "50.00000",
                "priceNet": "50.00000",
                "priceTotalNet": "50.00000",
                "customerPrice": "50.00000",
                "costPrice": "7.50000",
                "discount": "5.00000",
                "tax": "0.00000",
                "taxPercentage": "0.00000",
                "taxCode": "N",
                "isBonus": "N",
                "minimumQuantity": 1,
                "unit": 1,
                "package": "STK",
                "packageUnit": "",
                "packageUnitQuantity": "1",
                "purchaseUnit": 1,
                "purchaseMinimumQuantity": 1,
                "requestDate": null
            }
        ],
        "invoiceUserId": 14644,
        "validUntil": null,
        "companyId": null,
        "lastModifiedAt": "2024-12-30T12:18:45.048Z",
        "originalOrderId": 0,
        "exportedAt": null,
        "exportStatus": "",
        "exportMessage": null
    }
}

Contact​

{
  "contact": {
    "tenant": "example-tenant",
    "id": 54321,
    "firstName": "Jane",
    "middleName": "Elizabeth",
    "lastName": "Smith",
    "phone": "+1-555-234-5678",
    "email": "jane.smith@example.com",
    "iban": "DE89370400440532013000",
    "bankAccount": "987654321",
    "bic": "DEUTDEFF",
    "notes": "Prefers communication via phone",
    "debtorId": "CONT-54321",
    "login": "janesmith",
    "gender": "F",
    "mobile": "+1-555-876-5432",
    "expires": "2024-12-31T23:59:59.999Z",
    "externalId": "EXT-54321",
    "dateOfBirth": "1990-03-21T00:00:00.000Z",
    "mailingList": "Y",
    "createdAt": "2023-02-15T09:30:00.000Z",
    "lastModifiedAt": "2023-07-01T14:45:00.000Z",
    "company": {
      "id": 9876,
      "name": "Tech Innovations Inc.",
      "taxNumber": "US123456789",
      "cocNumber": "COC987654",
      "debtorId": "COMP-9876",
      "phone": "+1-555-987-6543",
      "email": "info@example.com",
      "notes": "Leading tech company in Silicon Valley",
      "path": "/companies/tech-innovations",
      "slug": "tech-innovations",
      "tag": "technology",
      "createdAt": "2022-01-01T00:00:00.000Z",
      "lastModifiedAt": "2023-06-30T12:00:00.000Z",
      "parentUsergroupId": 1000
    },
    "companies": [
      {
        "id": 9876,
        "name": "Tech Innovations Inc.",
        "taxNumber": "US123456789",
        "cocNumber": "COC987654",
        "debtorId": "COMP-9876",
        "phone": "+1-555-987-6543",
        "email": "info@example.com",
        "notes": "Leading tech company in Silicon Valley",
        "path": "/companies/tech-innovations",
        "slug": "tech-innovations",
        "tag": "technology",
        "createdAt": "2022-01-01T00:00:00.000Z",
        "lastModifiedAt": "2023-06-30T12:00:00.000Z",
        "parentUsergroupId": 1000
      },
      {
        "id": 5432,
        "name": "Global Solutions Ltd.",
        "taxNumber": "UK987654321",
        "cocNumber": "COC543210",
        "debtorId": "COMP-5432",
        "phone": "+44-20-1234-5678",
        "email": "info@example.com",
        "notes": "International consulting firm",
        "path": "/companies/global-solutions",
        "slug": "global-solutions",
        "tag": "consulting",
        "createdAt": "2021-06-15T00:00:00.000Z",
        "lastModifiedAt": "2023-05-20T10:30:00.000Z",
        "parentUsergroupId": 2000
      }
    ],
    "channelId": 3,
    "language": "EN"
  }
}

Customer​

{
  "customer": {
    "tenant": "example-tenant",
    "id": 12345,
    "debtorId": "CUST-12345",
    "gender": "M    ",
    "firstName": "John",
    "middleName": "Michael",
    "lastName": "Doe",
    "phone": "+1-555-123-4567",
    "mobile": "+1-555-987-6543",
    "email": "john.doe@example.com",
    "login": "johndoe",
    "iban": "NL91ABNA0417164300",
    "bankAccount": "123456789",
    "bic": "ABNANL2A",
    "notes": "Preferred contact method: email",
    "primaryLanguage": "EN",
    "expires": "2025-12-31T23:59:59.999Z",
    "externalId": "EXT-12345",
    "dateOfBirth": "1985-06-15T00:00:00.000Z",
    "mailingList": "Y",
    "isLoggedIn": true,
    "createdAt": "2023-01-01T10:00:00.000Z",
    "lastModifiedAt": "2023-06-30T15:30:00.000Z",
    "parentUsergroupId": 5,
    "channelId": 2,
    "language": "EN"
  }
}

PasswordReset​

{
    "passwordReset": {
        "email": "John.Doe@example.com",
        "redirectLink": "https://www.example.com/reset-password",
        "language": "NL"
    }
}