Skip to content
Branch: master
Find file History
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
..
Failed to load latest commit information.
README.md
index.js
package.json
yarn.lock

README.md

Short Order ID

This example demonstrates how you can create short order IDs using Moltin webhooks.

How to use locally

When running this example locally it's recommended you use a service like ngrok to tunnel your dev environment to the outside world.

Once you have the repo running locally, you'll want to add the integration via the Moltin Dashboard. The URL will be the one provided by ngrok.

1. Download the example

Clone the repository:

git clone git@github.com:moltin/integration-examples.git

Install dependencies with Yarn

cd integration-examples/short-order-id
yarn

2. Configure Flows

Moltin provides you the ability to extend core resources with the Flows feature. Go to the Moltin Dashboard and navigate to Settings > Flows.

Here you will want to create a new Flow (or edit if it already exists) for extending Orders. Give it a name and description you will recognise, but make sure the slug is set to orders.

Create New Flow

Next you will want to create a new Field for the Flow you just created.

Create New Field Button

Give the new Field a name and description you will recognise. Make sure the slug is set to short_id as this is what the serverless function expects.

Create New Field Form

Save this Field

3. Configure your ENV variables

You will want to create an .env inside the directory /short-order-id containing all the keys for the below:

MOLTIN_CLIENT_ID=
MOLTIN_CLIENT_SECRET=
MOLTIN_WEBHOOK_SECRET=

MOLTIN_WEBHOOK_SECRET can be anything you want.

4. Start the server and ngrok

Start the development server

yarn dev

The server will typically start on PORT 3000, if not, make a note for the next step.

Start ngrok

ngrok http 3000

This will expose PORT 3000 to the outside world. Make a note of the http URL ngrok provides.

5. Create a new Moltin integration

You must now tell Moltin the ngrok URL above. Head to the Moltin Dashboard, login and go to Settings > Integrations and click Create.

Enter a name and description for your Integration. We recommend you prefix the name with DEVELOPMENT:.

Next, enter the URL and Secret Key that match those inside .env.

URL and Secret Key

Now finally you'll want to configure when this webhook will be invoked, in this example check the Created box.

Observes selection

That's it! Click Save

You can’t perform that action at this time.