This is a function reference for gopherhq-js. View the readme.md file in the the repo that corresponds with this version. Also, view Gopher REST API and the Gopher API Docs for more information.

Get information about the extension that corresponds with user's Bearer token (ie, most likely your extension).

const res = await gopherClient.extensionGetSelf();

Send an Event to the extension. This does not require and auth token because the endpoint is meant for 3rd party services. Ex: issue created in Github, or an email response or support ticket received. The Gopher Extension can listen for events, act on tasks or create or delete tasks based on events.

const res = await gopherClient.sendEvent({type: 'event.type', payload: {"foo", "bar"}, event_url: "[unique_event_url]"});

Save Gopher extension data which is sent with every webhook related to that extension. This is how an extension persist's user settings specific to that extension. For params and details, see extension saving data API docs

const res = await gopherClient.saveExtensionData({ foo: "bar" });

Get saved Gopher extension data For params and details, see extension get data API docs

const res = await gopherClient.getExtensionData();

Low-level function to make authenticated request to Gopher API

Retrieve logged-in user's extension logs For params and details, see extension saving data API docs

Get a filtered list of Gopher tasks

// Get all open tasks, sorted by due date
const res = await gopherClient.getTasks();
console.log(res.tasks);

// With a callback
gopherClient.getTasks({ limit: 1 }, (err, res) => {
    if (err) done(err);
    console.log(res.tasks);
  });

Get a Gopher task Passing ?verbose=1 fires a webhook to the extnesion and fetches a rendered HTML email preview of the task

const res = await getTask({id: 123});

Create a new Gopher Task.

const res = await gopherClient.createTask(
    {
      webhook: false,
      suppress_email: true,
      verbose: 1,
      task: {
        command: process.env.EXAMPLE_COMMAND
      },
      send_messages: [
        {
          type: "email",
          subject: "A test email message",
          to: "test@example.com",
          body: [
            {
              type: "html",
              text: "<h1>This is a test</h1>"
            }
          ]
        }
      ]
    });

Send Email and automatically create a Task This creates a gopher task and sends an email. It's a wrapper for createTask with opinionated settings for just sending email.

const res = await gopherClient.sendEmail({
    command: command@my-ext.gopher.email,
    to: "test@exampletask.com",
    cc: [],
    bcc: [],
    from: "test@example.com",
    subject: "Test1",
    body: [
      {
        type: "html",
        text: "<h1>This is a test</h1>"
      }
    ]
  });

Update A Gopher Task Used to save data against the task, update content, followup time and more

const res = await gopherClient.updateTask({
   task: {
    id: 1234,
    reference_email: {
      to: "newRecipient@exampletask.com"
    }
  }});

Archive A Gopher Task

Permanently Delete A Gopher Task

Trigger a Gopher Task

Resolve Natural Time Format (ex: {naturaltime}@ext.gopher.email)

Dispatch an email-based action for a task. (Equivalent to sending an action email.)

Get information about the currently logged in user

Invite users to this extension. If an Auth token is included, the invitation email includes the name of the logged in user who is sending the invitation. "emails" param can be either an array of email addresses, or a string with a single email address.

Validate webhook signature. Set verifyAge to false when testing / mocking HTTP requests. (Server side only)