beew
    TypeScript icon, indicating that this package has built-in type declarations

    1.1.1 • Public • Published

    Welcome to beew 👋

    The simplest way of scheduling HTTP requests

    • Pick a common schedule or use UNIX-CRON schedule expression.
    • Schedule a request for a specific date.
    • Schedule your request in any timezone.
    • Register logs of your requests and responses.
    • Receive a email notification every time one of your requests fails

    Install

    npm install --save beew

    Create a Beew Account

    You need to have a Beew account to create schedules. Go to app.beew.io and sign up.

    Usage with Typescript

    import { Beew, ScheduleMethod, ScheduleResponseType, ScheduleType } from "beew";
    
    /*
     * You can find your Beew secret in the Beew dashboard.
     * https://app.beew.io/en/api-settings
     */
    const client = new Beew({ secret: "YOU_API_KEY_HERE" });
    
    client.schedule.create({
      name: "test",
      cronExpression: "* * * * *",
      url: "https://beew.io/api/v1/health/ok",
      notifyOnError: false,
      headers: [],
      payload: JSON.stringify({}),
      timezone: "America/Sao_Paulo",
      method: ScheduleMethod.GET,
      responseType: ScheduleResponseType.JSON,
      type: ScheduleType.RECURRING,
    });

    Here is a list of all available methods:

    Method Description
    client.schedule.create(args) Create a new schedule
    client.schedule.update(args) Update schedule
    client.schedule.get('schedule_id') Get schedule by id
    client.schedule.delete('schedule_id') Delete schedule
    client.execution.get('execution_id') Get execution by id

    Install

    npm i beew

    DownloadsWeekly Downloads

    27

    Version

    1.1.1

    License

    MIT

    Unpacked Size

    46.1 kB

    Total Files

    23

    Last publish

    Collaborators

    • caiorolla