Create User Invitation with Clerk API on Custom Interval from Schedule API

Pipedream makes it easy to connect APIs for Clerk, Schedule and 2,400+ other apps remarkably fast.

Trigger workflow on

Custom Interval from the Schedule API

Next, do this

Create User Invitation with the Clerk 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 Schedule trigger and Clerk action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the Custom Interval trigger
1. Connect your Schedule account
2. Configure Cron Schedule
Configure the Create User Invitation action
1. Connect your Clerk account
2. Configure Email Address
3. Optional- Configure Public Metadata
4. Optional- Configure Redirect URL
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#

Custom Interval on Schedule

Description:Trigger your workflow every N hours, minutes or seconds.

Version:0.0.2

Key:schedule-custom-interval

View on GitHub

Schedule Overview#

The Schedule app in Pipedream is a powerful tool that allows you to trigger workflows at regular intervals, ranging from every minute to once a year. This enables the automation of repetitive tasks and the scheduling of actions to occur without manual intervention. By leveraging this API, you can execute code, run integrations, and process data on a reliable schedule, all within Pipedream's serverless environment.

Trigger Code#

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

export default {
  name: "Custom Interval",
  version: "0.0.2",
  key: "schedule-custom-interval",
  type: "source",
  description: "Trigger your workflow every N hours, minutes or seconds.",
  props: {
    schedule,
    cron: {
      propDefinition: [
        schedule,
        "cron",
      ],
    },
  },
};

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
Schedule	`schedule`	`app`	This component uses the Schedule app.
Cron Schedule	`cron`	`$.interface.timer`	Enter a cron expression

Trigger Authentication#

The Schedule API does not require authentication.

About Schedule#

Trigger workflows on an interval or cron schedule.

Action#

Create User Invitation on Clerk

Description:Creates a new invitation for the given email address and sends the invitation email. Keep in mind that you cannot create an invitation if there is already one for the given email address. Also, trying to create an invitation for an email address that already exists in your application will result to an error. [See the documentation](https://clerk.com/docs/reference/backend-api/tag/Invitations#operation/CreateInvitation)

Version:0.0.1

Key:clerk-create-user-invitation

View on GitHub

Clerk Overview#

The Clerk API lets you manage user authentication and create secure, delightful user experiences in your apps. Within Pipedream's serverless platform, you can harness this API to automate workflows that trigger on user events, sync user data across apps, and maintain robust user management without the heavy lifting of building authentication infrastructure from scratch.

Action Code#

import clerk from "../../clerk.app.mjs";
import { parseObject } from "../../common/utils.mjs";

export default {
  key: "clerk-create-user-invitation",
  name: "Create User Invitation",
  version: "0.0.1",
  description: "Creates a new invitation for the given email address and sends the invitation email. Keep in mind that you cannot create an invitation if there is already one for the given email address. Also, trying to create an invitation for an email address that already exists in your application will result to an error. [See the documentation](https://clerk.com/docs/reference/backend-api/tag/Invitations#operation/CreateInvitation)",
  type: "action",
  props: {
    clerk,
    emailAddress: {
      type: "string",
      label: "Email Address",
      description: "The email address the invitation will be sent to.",
    },
    publicMetadata: {
      propDefinition: [
        clerk,
        "publicMetadata",
      ],
      description: "Metadata that will be attached to the newly created invitation. The value of this property should be a well-formed JSON object. Once the user accepts the invitation and signs up, these metadata will end up in the user's public metadata.",
      optional: true,
    },
    redirectUrl: {
      type: "string",
      label: "Redirect URL",
      description: "Optional URL which specifies where to redirect the user once they click the invitation link. This is only required if you have implemented a [custom flow](https://clerk.com/docs/custom-flows/invitations#custom-flow) and you're not using Clerk Hosted Pages or Clerk Components.",
      optional: true,
    },
  },
  async run({ $ }) {
    const response = await this.clerk.createUserInvitation({
      $,
      data: {
        email_address: this.emailAddress,
        public_metadata: parseObject(this.publicMetadata),
        redirect_url: this.redirectUrl,
      },
    });

    $.export("$summary", `A new invitation with Id: ${response.id} was successfully created!`);
    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
Clerk	`clerk`	`app`	This component uses the Clerk app.
Email Address	`emailAddress`	`string`	The email address the invitation will be sent to.
Public Metadata	`publicMetadata`	`object`	Metadata that will be attached to the newly created invitation. The value of this property should be a well-formed JSON object. Once the user accepts the invitation and signs up, these metadata will end up in the user's public metadata.
Redirect URL	`redirectUrl`	`string`	Optional URL which specifies where to redirect the user once they click the invitation link. This is only required if you have implemented a custom flow and you're not using Clerk Hosted Pages or Clerk Components.

Action Authentication#

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

About Clerk#

Drop-in authentication for React and React Native.

More Ways to Connect Clerk + Schedule#

Other Popular Integrations#

Create User Invitation with Clerk API on Daily schedule from Schedule API

Schedule + Clerk

Try it

Create User Invitation with Clerk API on Weekly schedule from Schedule API

Schedule + Clerk

Try it

Create User Invitation with Clerk API on Monthly Schedule from Schedule API

Schedule + Clerk

Try it

Create User with Clerk API on Daily schedule from Schedule API

Schedule + Clerk

Try it

Create User with Clerk API on Weekly schedule from Schedule API

Schedule + Clerk

Try it

Popular Triggers#

Custom Interval from the Schedule API

Trigger your workflow every N hours, minutes or seconds.

Try it

Daily schedule from the Schedule API

Trigger your workflow every day.

Try it

Monthly Schedule from the Schedule API

Trigger your workflow on one or more days each month at a specific time (with timezone support).

Try it

Weekly schedule from the Schedule API

Trigger your workflow on one or more days each week at a specific time (with timezone support).

Try it

Popular Actions#

Create User with the Clerk API

Creates a new user. Your user management settings determine how you should setup your user model. See the documentation

Try it

Create User Invitation with the Clerk API

Creates a new invitation for the given email address and sends the invitation email. Keep in mind that you cannot create an invitation if there is already one for the given email address. Also, trying to create an invitation for an email address that already exists in your application will result to an error. See the documentation

Try it

Delete User with the Clerk API

Delete the specified user. See the documentation

Try it

Get User with the Clerk API

Retrieve the details of a specific user. See the documentation

Try it

Get User Memberships with the Clerk API

Retrieve a list of the user's organization memberships. See the documentation

Try it