Create Transcription with OpenAI (ChatGPT) API on New Candidate Status Change (Instant) from Clockwork Recruiting API

Pipedream makes it easy to connect APIs for OpenAI (ChatGPT), Clockwork Recruiting and 2,800+ other apps remarkably fast.

Trigger workflow on

New Candidate Status Change (Instant) from the Clockwork Recruiting API

Next, do this

Create Transcription with the OpenAI (ChatGPT) 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 Clockwork Recruiting trigger and OpenAI (ChatGPT) action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Candidate Status Change (Instant) trigger
1. Connect your Clockwork Recruiting account
Configure the Create Transcription action
1. Connect your OpenAI (ChatGPT) account
2. Configure File Path or URL
3. Select a Model
4. Optional- Configure Include
5. Optional- Configure Language
6. Optional- Configure Prompt
7. Optional- Select a Response Format
8. Optional- Configure Temperature
9. Optional- Configure Timestamp Granularities
10. Optional- Configure syncDir
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#

New Candidate Status Change (Instant) on Clockwork Recruiting

Description:Emit new event when a candidate status is changed.

Version:0.0.1

Key:clockwork_recruiting-candidate-status-change

View on GitHub

Clockwork Recruiting Overview#

The Clockwork Recruiting API offers a suite of features tailored for executive search firms and in-house recruiting teams, enabling users to manage candidates, clients, and search projects with ease. By integrating this API with Pipedream, you can automate the recruitment process, sync data between various platforms, and streamline candidate engagement and tracking. Pipedream's serverless platform facilitates the creation of custom workflows using the Clockwork Recruiting API to optimize recruitment operations without manual intervention.

Trigger Code#

import app from "../../clockwork_recruiting.app.mjs";
import sampleEmit from "./test-event.mjs";

export default {
  key: "clockwork_recruiting-candidate-status-change",
  name: "New Candidate Status Change (Instant)",
  description: "Emit new event when a candidate status is changed.",
  version: "0.0.1",
  type: "source",
  dedupe: "unique",
  props: {
    app,
    http: "$.interface.http",
    db: "$.service.db",
  },
  hooks: {
    async activate() {
      const { id } = await this.app.createHook({
        data: {
          hook_url: this.http.endpoint,
        },
      });

      this._setHookId(id);
    },
    async deactivate() {
      const id = this._getHookId("hookId");
      await this.app.deleteHook(id);
    },
  },
  methods: {
    emitEvent(body) {
      const {
        event_name: event,
        candidacy,
      } = body;

      if (event === "candidacy_updated") {
        const {
          id, status_id: statusId, updated_at: updatedAt,
        } = candidacy;

        this.$emit(body, {
          id: id + statusId,
          summary: `The status of the candidate with id ${id} has been updated!`,
          ts: new Date(updatedAt),
        });
      }
    },
    _getHookId() {
      return this.db.get("hookId");
    },
    _setHookId(hookId) {
      this.db.set("hookId", hookId);
    },
    _getLastStatusId() {
      return this.db.get("lastStatusId");
    },
    _setLastStatusId(statusId) {
      this.db.set("lastStatusId", statusId);
    },
  },
  async run({ body }) {
    this.emitEvent(body);
  },
  sampleEmit,
};

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
Clockwork Recruiting	`app`	`app`	This component uses the Clockwork Recruiting app.
N/A	`http`	`$.interface.http`	This component uses `$.interface.http` to generate a unique URL when the component is first instantiated. Each request to the URL will trigger the `run()` method of the component.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.

Trigger Authentication#

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

To retrieve your API Key, API Secret, and Firm Service Key

Navigate to your Clockwork Recruiting account and sign in
Click the drop down on the top right
Go to Profile
Scroll down to API Keys

About Clockwork Recruiting#

Executive search software and business solutions for executive search firms, in-house teams and venture capital.

Action#

Create Transcription on OpenAI (ChatGPT)

Description:Transcribes audio into the input language. [See the documentation](https://platform.openai.com/docs/api-reference/audio/createTranscription)

Version:0.3.3

Key:openai-create-transcription

View on GitHub

OpenAI (ChatGPT) Overview#

OpenAI provides a suite of powerful AI models through its API, enabling developers to integrate advanced natural language processing and generative capabilities into their applications. Here’s an overview of the services offered by OpenAI's API:

Use Python or Node.js code to make fully authenticated API requests with your OpenAI account:

Action Code#

import { getFileStreamAndMetadata } from "@pipedream/platform";
import openai from "../../openai.app.mjs";
import FormData from "form-data";
import { TRANSCRIPTION_MODELS } from "../../common/models.mjs";

export default {
  key: "openai-create-transcription",
  name: "Create Transcription",
  description: "Transcribes audio into the input language. [See the documentation](https://platform.openai.com/docs/api-reference/audio/createTranscription)",
  version: "0.3.3",
  annotations: {
    destructiveHint: false,
    openWorldHint: true,
    readOnlyHint: false,
  },
  type: "action",
  props: {
    openai,
    file: {
      propDefinition: [
        openai,
        "file",
      ],
    },
    model: {
      type: "string",
      label: "Model",
      description: "ID of the model to use",
      options: TRANSCRIPTION_MODELS,
    },
    include: {
      type: "string[]",
      label: "Include",
      description: "Additional information to include in the transcription response. `logprobs` will return the log probabilities of the tokens in the response to understand the model's confidence in the transcription. `logprobs` only works with response_format set to `json` and only with the models `gpt-4o-transcribe` and `gpt-4o-mini-transcribe`.",
      optional: true,
    },
    language: {
      type: "string",
      label: "Language",
      description: "The language of the input audio. Supplying the input language in [ISO-639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) (e.g. en) format will improve accuracy and latency.",
      default: "en",
      optional: true,
    },
    prompt: {
      type: "string",
      label: "Prompt",
      description: "An optional text to guide the model's style or continue a previous audio segment. The [prompt](https://platform.openai.com/docs/guides/speech-to-text#prompting) should match the audio language.",
      optional: true,
    },
    response_format: {
      type: "string",
      label: "Response Format",
      description: "The format of the output. For `gpt-4o-transcribe` and `gpt-4o-mini-transcribe`, the only supported format is `json`.",
      options: [
        "json",
        "text",
        "srt",
        "verbose_json",
        "vtt",
      ],
      optional: true,
    },
    temperature: {
      type: "string",
      label: "Temperature",
      description: "The sampling temperature, between 0 and 1. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. If set to 0, the model will use log probability to automatically increase the temperature until certain thresholds are hit.",
      optional: true,
    },
    timestamp_granularities: {
      type: "string[]",
      label: "Timestamp Granularities",
      description: "The timestamp granularities to populate for this transcription. `response_format` must be set `verbose_json` to use timestamp granularities. Either or both of these options are supported: `word`, or `segment`. Note: There is no additional latency for segment timestamps, but generating word timestamps incurs additional latency.",
      optional: true,
    },
    syncDir: {
      type: "dir",
      accessMode: "read",
      sync: true,
      optional: true,
    },
  },
  methods: {
    createTranscription(opts = {}) {
      return this.openai._makeRequest({
        method: "POST",
        path: "/audio/transcriptions",
        ...opts,
      });
    },
  },
  async run({ $ }) {
    const {
      /* eslint-disable no-unused-vars */
      openai,
      file,
      createTranscription,
      ...fields
    } = this;

    const data = new FormData();
    const {
      stream, metadata,
    } = await getFileStreamAndMetadata(file);

    data.append("file", stream, {
      contentType: metadata.contentType,
      knownLength: metadata.size,
      filename: metadata.name,
    });

    for (const [
      key,
      value,
    ] of Object.entries(fields)) {
      const v = Array.isArray(value)
        ? value.join(",")
        : value;
      data.append(key, v);
    }

    const response = await createTranscription({
      $,
      data,
      headers: data.getHeaders(),
    });

    $.export("$summary", "Successfully converted speech to text");
    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
OpenAI (ChatGPT)	`openai`	`app`	This component uses the OpenAI (ChatGPT) app.
File Path or URL	`file`	`string`	The file to process. Provide either a file URL or a path to a file in the `/tmp` directory (for example, `/tmp/myFile.txt`). See the Assistants Tools guide to learn more about the types of files supported. The Fine-tuning API only supports `.jsonl` files.
Model	`model`	`string`	Select a value from the drop down menu:`gpt-4o-transcribegpt-4o-mini-transcribewhisper-1`
Include	`include`	`string[]`	Additional information to include in the transcription response. `logprobs` will return the log probabilities of the tokens in the response to understand the model's confidence in the transcription. `logprobs` only works with response_format set to `json` and only with the models `gpt-4o-transcribe` and `gpt-4o-mini-transcribe`.
Language	`language`	`string`	The language of the input audio. Supplying the input language in ISO-639-1 (e.g. en) format will improve accuracy and latency.
Prompt	`prompt`	`string`	An optional text to guide the model's style or continue a previous audio segment. The prompt should match the audio language.
Response Format	`response_format`	`string`	Select a value from the drop down menu:`jsontextsrtverbose_jsonvtt`
Temperature	`temperature`	`string`	The sampling temperature, between 0 and 1. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. If set to 0, the model will use log probability to automatically increase the temperature until certain thresholds are hit.
Timestamp Granularities	`timestamp_granularities`	`string[]`	The timestamp granularities to populate for this transcription. `response_format` must be set `verbose_json` to use timestamp granularities. Either or both of these options are supported: `word`, or `segment`. Note: There is no additional latency for segment timestamps, but generating word timestamps incurs additional latency.
syncDir	`syncDir`	`dir`

Create Transcription with OpenAI (ChatGPT) API on New Candidate Status Change (Instant) from Clockwork Recruiting API

Pipedream makes it easy to connect APIs for OpenAI (ChatGPT), Clockwork Recruiting and 2,800+ other apps remarkably fast.

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

Developers ♥ Pipedream

1-24of2,800+apps by most popular

1
-
24
of
2,800+
apps by most popular