Unofficial Stackfield API client

Stackfield API client for Node.js and the browser.

Getting started

Installation

$ npm install stackfield-unofficial

Add a Webhook

Follow the official documentation to add a Webhook integration of the appropriate type.

Usage

Send a chat message

import * as stackfield from 'stackfield-unofficial';

const message: stackfield.ChatMessage = {
  title: 'Hello, world!',
};

await stackfield.sendChatMessage({
  webhookUrl: 'https://www.stackfield.com/apiwh/d4c7e4cf-2503-4d2c-99eb-7a5cf5f4b925',
  message: message,
});

Upload a file

<form id="myForm">
  <input type="file" name="myFile" />
  <button type="submit">Upload</button>
</form>

<script>
  const form = document.querySelector('#myForm');
  form.addEventListener('submit', async (e) => {
    e.preventDefault();
    const formData = new FormData(form);
    const file = formData.get('myFile');

    await stackfield.uploadFile({
      webhookUrl: 'https://www.stackfield.com/apiwh/d4c7e4cf-2503-4d2c-99eb-7a5cf5f4b925',
      file: { file: file, fileName: file.name },
    });
  });
</script>

Error handling

import { sendChatMessage, StackfieldError } from 'stackfield-unofficial';

try {
  await sendChatMessage({
    webhookUrl: 'https://www.stackfield.com/apiwh/d4c7e4cf-2503-4d2c-99eb-7a5cf5f4b925',
    message: { title: 'Hello, world!' },
  });
} catch (err) {
  if (err instanceof StackfieldError) {
    console.log(`Stackfield responded with error code: ${err.errorCode}`);
  }
}

Custom fetch method

import * as stackfield from 'stackfield-unofficial';

await stackfield.sendChatMessage(
  {
    webhookUrl: 'https://www.stackfield.com/apiwh/d4c7e4cf-2503-4d2c-99eb-7a5cf5f4b925',
    message: {
      title: 'Hello, world!',
    },
  },
  {
    fetch: (input, init) => {
      const headers = new Headers(init?.headers);
      headers.set('Custom-Header', 'value');

      return fetch(input, { ...init, headers });
    },
  }
);

Available methods

• sendChatMessage
• createDiscussion
• createTask
• createPage
• uploadFile
• createEvent
• createSnippet - endpoint has no official documentation and is therefore not supported

Enterprise features

Enterprise features are not supported. We do not have access to the Enterprise features and therefore cannot reliably test them.