Segment
Parcelvoy currently supports both ingesting events from Segment and sending events to Segment. Follow the instructions for each below.
Outbound
To setup Parcelvoy as a source for events going into Segment, you first need to create a Source in Segment.
- Open Segment and navigate to
Connections -> Sourcesand clickAdd Source - Search for
Node.jsand select that server source to be added - Pick whatever name you would like and hit
Add Sourceto finish - The source screen should present you with a
Write Keywhich is needed to setup the intergration on Parcelvoy. Copy this for later. - Navigate to Parcelvoy and go to
Settings -> Integrations - Hit
Add Integrationand pick Segment - Enter the
Write Keyfor the Segment Source you previously created and hit save. - That's it! After you save the integration all future events will flow into the source you created.
Inbound
There is currently no Destination in Segment for Parcelvoy, however Parcelvoy does have a Segment compatible endpoint that can be used for webhooks.
- Open Parcelvoy and go to
Settings -> API Keys - Hit
Create Key, enterSegment(or whatever you want) as the name,Publicas the scope and then hit create. - Copy the key so you have it for later
- Open Segment and navigate to
Connections -> Destinationsand clickAdd Destination - Search for
Webhooksand pick the Destination titleWebhooks (Actions) - Hit
Configure Webhooks (Actions)in the top right of the next screen - Select whatever data source you want to ingest data from and hit Next
- Enter a name and then hit
Select destination - Create a new Mapping of type
Send - For the first section, pick
Event Typeas the condition andTrackas the event type. Parcelvoy supportsTrack,IdentifyandAliasevents, so select all three as separate conditions to receive all data. - Under mappings, enter the following information:
- URL: Enter your domain along with the path
/api/client/segment(i.e.https://test.com/api/client/segment) - Method: POST
- Headers: Set the key as
Authorizationand the value toBearer API_KEYwhereAPI_KEYis the key you created in Parcelvoy - Data: Leave as is
- Enable Batching: Set to true
- URL: Enter your domain along with the path
- Save the destination and enable to start sending events into Parcelvoy!.