Skip to main content

Webhooks and events

The Event Action Manager lets you subscribe to events that happen within the Propeller platform and trigger actions with the event's payload. You configure event actions through the Propeller backoffice.

Action types

Each event action has a trigger (the event) and an action type (what happens when the event fires):

Action typeDescription
SEND_EMAILRenders a template using the event data and sends it as an email
POST_TO_WEBHOOKSends the event payload as a JSON POST request to a webhook endpoint

You can create multiple actions for the same event trigger.

Event triggers

Company events

TriggerDescription
COMPANY_CREATEDA new company is created
COMPANY_UPDATEDAn existing company is modified
COMPANY_DELETEDA company is removed
COMPANY_BULKBatch operation on companies

Contact events

TriggerDescription
CONTACT_CREATEDA new contact is created
CONTACT_UPDATEDAn existing contact is modified
CONTACT_DELETEDA contact is removed
CONTACT_BULKBatch operation on contacts
CONTACT_SEND_WELCOME_EMAILWelcome email triggered for a new contact

Customer events

TriggerDescription
CUSTOMER_CREATEDA new customer is created
CUSTOMER_UPDATEDAn existing customer is modified
CUSTOMER_DELETEDA customer is removed
CUSTOMER_BULKBatch operation on customers
CUSTOMER_SEND_WELCOME_EMAILWelcome email triggered for a new customer

Order events

TriggerDescription
ORDER_CREATEDA new order or quote is created
ORDER_UPDATEDAn existing order or quote is modified
ORDER_DELETEDAn order or quote is removed
ORDER_BULKBatch operation on orders
ORDER_SEND_CONFIRMATIONOrder confirmation triggered (checkout or Sales Portal)

Quote events

TriggerDescription
QUOTE_SENDA quote proposal is sent
QUOTE_SEND_REQUESTA quote request confirmation is sent
QUOTE_SEND_VALIDATIONA quote is routed for validation

Cart events

TriggerDescription
CART_SEND_REQUEST_PURCHASE_AUTHORIZATIONA purchase authorization request is dispatched

Authentication events

TriggerDescription
SEND_INIT_PASSWORDInitial password setup email triggered
SEND_RESET_PASSWORDPassword recovery email triggered

Other

TriggerDescription
CUSTOM_EVENTUser-defined event with a custom payload

Payload types

Webhook endpoints receive a JSON POST request containing the event payload. The payload structure depends on the event domain:

DomainEventsPayload includes
OrderORDER_*, QUOTE_*Order metadata, status, financial data (payment, postage, totals), line items with pricing, shipping/billing addresses, user/account/channel IDs
ContactCONTACT_*Contact information, company associations, financial details (IBAN/BIC), communication preferences, channel assignment
CustomerCUSTOMER_*Personal and contact data, authentication status, language preferences, lifecycle dates, organizational relationships
CompanyCOMPANY_*Company data
CartCART_*Cart data
PasswordSEND_INIT_PASSWORD, SEND_RESET_PASSWORDEmail address, reset link URL, language preference
CustomCUSTOM_EVENTUser-defined payload

Webhook security

Two security methods are available for verifying webhook requests. Both are configured through the API.

HMAC signature verification

Propeller generates an HMAC-SHA256 signature using a secret salt that you configure. The signature is included in the X-Propeller-Signature header with the format:

X-Propeller-Signature: sha256=<signature>

Your endpoint should compute the HMAC-SHA256 of the raw request body using the same secret and compare it against the header value to verify the request is authentic.

Basic authentication

Propeller sends a username and password with each webhook request using the Authorization: Basic header:

Authorization: Basic <base64-encoded credentials>

The password is stored securely and is not displayed after saving.