Run Cypher Query with Neo4j AuraDB API on Student Added to Course from Xperiencify API

Pipedream makes it easy to connect APIs for Neo4j AuraDB, Xperiencify and 2,700+ other apps remarkably fast.

Trigger workflow on

Student Added to Course from the Xperiencify API

Next, do this

Run Cypher Query with the Neo4j AuraDB API

No credit card required

▶

Watch us build a workflow

8 min

Watch now ➜

Trusted by 1,000,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

Getting Started#

This integration creates a workflow with a Xperiencify trigger and Neo4j AuraDB action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the Student Added to Course trigger
1. Connect your Xperiencify account
2. Configure timer
3. Select a Course
Configure the Run Cypher Query action
1. Connect your Neo4j AuraDB account
2. Configure Execute Cypher Query
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Details#

This integration uses pre-built, source-available components from Pipedream's GitHub repo. These components are developed by Pipedream and the community, and verified and maintained by Pipedream.

To contribute an update to an existing component or create a new component, create a PR on GitHub. If you're new to Pipedream component development, you can start with quickstarts for trigger span and action development, and then review the component API reference.

Trigger#

Student Added to Course on Xperiencify

Description:Emit new event when a student enrolls into a course.

Version:0.0.2

Key:xperiencify-student-added-to-course

View on GitHub

Xperiencify Overview#

Xperiencify is a platform designed to create engaging online courses that motivate students through gamification and psychological triggers. The Xperiencify API allows course creators to manage and automate tasks related to courses, students, and their progress. With Pipedream, you can harness this API to create dynamic workflows that respond to course enrollments, progress milestones, and other student interactions. Automate notifications, gather analytics, synchronize with other platforms, and more, creating a seamless integration between Xperiencify and your digital ecosystem.

Trigger Code#

import { defineSource } from "@pipedream/types";
import xperiencify from "../../app/xperiencify.app.mjs";
import { DEFAULT_POLLING_SOURCE_TIMER_INTERVAL } from "@pipedream/platform";
export default defineSource({
    name: "Student Added to Course",
    description: "Emit new event when a student enrolls into a course.",
    key: "xperiencify-student-added-to-course",
    version: "0.0.2",
    type: "source",
    dedupe: "unique",
    props: {
        xperiencify,
        db: "$.service.db",
        timer: {
            type: "$.interface.timer",
            default: {
                intervalSeconds: DEFAULT_POLLING_SOURCE_TIMER_INTERVAL,
            },
        },
        courseId: {
            propDefinition: [
                xperiencify,
                "courseId",
            ],
        },
    },
    methods: {
        getMeta({ email, firstName, }) {
            return {
                id: email,
                summary: `New student ${firstName}: ${email}`,
                ts: new Date().getTime(),
            };
        },
    },
    async run() {
        const all = await this.xperiencify.getStudentsForCourse({
            courseId: this.courseId,
        });
        for (const student of all) {
            this.$emit(student, this.getMeta(student));
        }
    },
});

Trigger Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI and CLI.

Label	Prop	Type	Description
Xperiencify	`xperiencify`	`app`	This component uses the Xperiencify app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
	`timer`	`$.interface.timer`
Course	`courseId`	`integer`	Select a value from the drop down menu.

Trigger Authentication#

Xperiencify uses API keys for authentication. When you connect your Xperiencify account, Pipedream securely stores the keys so you can easily authenticate to Xperiencify APIs in both code and no-code steps.

To retrieve your API key:

Navigate to your Xperiencify account and sign in
Go to Account > Advanced > API

About Xperiencify#

Xperiencify is the world's first fully gamified online course platform that creates a hyper-engaging "experience" for your students.

Action#

Run Cypher Query on Neo4j AuraDB

Description:Executes a Cypher query against the Neo4j AuraDB instance. [See the documentation](https://neo4j.com/docs/query-api/current/query/)

Version:0.0.1

Key:neo4j_auradb-run-query

View on GitHub

Action Code#

import app from "../../neo4j_auradb.app.mjs";

export default {
  key: "neo4j_auradb-run-query",
  name: "Run Cypher Query",
  description: "Executes a Cypher query against the Neo4j AuraDB instance. [See the documentation](https://neo4j.com/docs/query-api/current/query/)",
  version: "0.0.1",
  type: "action",
  props: {
    app,
    cypherQuery: {
      type: "string",
      label: "Execute Cypher Query",
      description: "A valid Cypher query to execute against the Neo4j AuraDB instance.",
    },
  },
  async run({ $ }) {
    const response = await this.app.executeCypherQuery({
      $,
      cypherQuery: this.cypherQuery,
    });
    $.export("$summary", "Executed Cypher query successfully");
    return response;
  },
};

Action Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI.

Label	Prop	Type	Description
Neo4j AuraDB	`app`	`app`	This component uses the Neo4j AuraDB app.
Execute Cypher Query	`cypherQuery`	`string`	A valid Cypher query to execute against the Neo4j AuraDB instance.

Action Authentication#

Neo4j AuraDB uses API keys for authentication. When you connect your Neo4j AuraDB account, Pipedream securely stores the keys so you can easily authenticate to Neo4j AuraDB APIs in both code and no-code steps.

Neo4j AuraDB requires their users enter their Neo4j AuraDB instance's username and password in order to connect to their API. For more info, refer to Neo4j AuraDB’s documentation

Pipedream recommends using a strong and unique password for your Neo4j AuraDB account.

Note that your username and password foryour Neo4j AuraDB instance is shown only once when you create the instance.

To get your API URL:

Retrieve the Base URL: Sign in to your Neo4j AuraDB account, navigate to Data services > Instances, click the ellipsis (⋮) on your chosen instance, select Inspect, and copy the provided Query API URL, which will look like: https://aura_instance_id.databases.neo4j.io/db/{databaseName}/query/v2
Find Your Database Name: Go to Tools > Query, click on Connect to instance, and in the pop-up select Connect. Then, check the Database dropdown at the top of the Query page to see your actual database name.
Form the Final URL: Replace the {databaseName} placeholder in the base URL with your actual database name. For example, if your database name is ABCD, the final Query API URL will be:
https://aura_instance_id.databases.neo4j.io/db/ABCD/query/v2