DOCSEARCHbyAlgolia
Submit Docs

Parcelvoy Documentation

website·Indexed 31 days ago

https://docs.parcelvoy.com

Open-source automated messaging and customer engagement tool. Includes guides for Client and Admin APIs, SDKs for Android, iOS (Swift), and JavaScript, and integrations with providers such as PostHog, SES, Twilio, Sendgrid, Segment, Mailgun, and Vonage.

Tokens
16.1K
Snippets
80
Records
136
Agent score
50%

What's inside Parcelvoy

  1. Overview of ParcelVoy Journeys

    Journeys are configurable sequences of automated actions used to personalize user communications. They function as an automation engine to send messages, update user profiles, and perform scheduled actions. Common use cases include welcome experiences, level-up notifications, cart abandonment sequences, special offers, recurring content, and expiration notifications. A journey consists of an Entrance step (which defines how a user enters the journey) and a series of connected Steps managed via a visual editor.

  2. Overview of Parcelvoy

    Parcelvoy is an open-source automated messaging and customer engagement tool designed for growth companies and enterprises. It aims to provide the user experience of a SaaS product while maintaining the flexibility of an open-source tool.

  3. Understand Parcelvoy Campaigns and supported channels

    Campaigns are the primary mechanism for all messaging within Parcelvoy, including email blasts and webhook calls within a journey. A campaign manages the scheduling, targeting, and design of a communication before passing the transmission to a provider. Parcelvoy supports four basic communication channels: Email, Text (SMS), Push Notification, and Webhook.

  4. Manage user communication with Subscription Groups

    Subscription Groups allow you to categorize different types of communications (e.g., 'deals' vs 'weekly inspiration'). Users can opt-in or opt-out of specific groups independently, determining which types of messages they continue to receive across various providers.

  5. Request production access for Amazon SES

    New Amazon SES accounts start in sandbox mode. To send emails in production, you must request approval from AWS. It is recommended to do this early and provide detailed context about your product to increase the chances of approval.
    1. Navigate to the AWS SES portal (https://console.aws.amazon.com/ses/home).
    2. Click the 'Request Production Access' button on the account dashboard.
    3. Complete and submit the form with product details.

  6. Understand Parcelvoy Integrations

    Integrations in Parcelvoy are used to configure how communications are sent. They are project-specific, allowing developers to use different providers for different environments (e.g., using one provider for a test project and another for a production project).

  7. Understand Parcelvoy User identification and properties

    In Parcelvoy, a user is a data record consisting of reserved properties (collected by default by client libraries) and custom properties defined by the developer. To exist in the system, a user must have at least one identifier: either an anonymous_id or an external_id. If no external_id is provided, Parcelvoy assigns an anonymous_id automatically.

  8. Understand Parcelvoy template types and rendering

    Parcelvoy uses Handlebars templates to render final messages for campaigns. There are four primary template types, each with specific rendering behaviors:

    • Email: Includes fields like subject, body, and cc. The html field is rendered as HTML and supports inline styles.
    • Text Message: A single field where content length is critical; Handlebars variables may increase the total length.
    • Push Notification: Consists of a title, a JSON body, and a text piece. All fields support Handlebars.
    • Webhooks: A wrapper for HTTP REST requests. Handlebars is interpreted only at the value level of the body and headers objects, not the keys.

  9. Understand Parcelvoy Providers

    Providers are the integration building blocks that enable Parcelvoy to perform external actions. They are categorized into two primary types: senders (used for delivering messages via SMS, Email, or Push Notifications) and analytics (used for event tracking and data analysis).

  10. Manage project-specific configurations in ParcelVoy

    Project settings in ParcelVoy are configured on a per-project basis. This project-specific architecture allows developers to maintain flexible configurations for different use cases, such as separating testing and production environments or creating distinct configurations for different clients.

  11. Manage Multi-Platform Push Notification Providers

    Parcelvoy groups Apple (APNs) and Google (Firebase) push notifications under a single provider integration (APN & Firebase). If you only wish to target one platform, leave the configuration fields for the other platform blank; devices on the excluded platform will be automatically omitted from sends.

  12. Configure SMTP integration for sending emails

    The SMTP integration allows you to send emails using almost any email account. Note that standard email inboxes often have low daily sending limits; for bulk or transactional emails, it is recommended to use a dedicated email service provider.

    To set up the integration:

    1. Go to the Parcelvoy integrations page.
    2. Click Add Integration and select SMTP.
    3. Provide the Host, Port, and authentication credentials for your email account.
    4. Click Create Integration.