Seneca Checkly-Provider is a plugin for Seneca

Provides access to the Checkly API using the Seneca provider convention. Checkly API entities are represented as Seneca entities so that they can be accessed using the Seneca entity API and messages.

See seneca-entity and the Seneca Data Entities Tutorial for more details on the Seneca entity API.

NOTE: underlying third party SDK needs to be replaced as out of date and has a security issue.

	This open source module is sponsored and supported by Voxgig.

Quick Example

// Setup - get the key value (<SECRET>) separately from a vault or
// environment variable.
Seneca()
  // Get API keys using the seneca-env plugin
  .use('env', {
    var: {
      $CHECKLYHQ_TOKEN: String,
      $CHECKLYHQ_ACCID: String,
    }
  })
  .use('provider', {
    provider: {
      checklyhq: {
        keys: {
          token: { value: '$CHECKLYHQ_TOKEN' },
          account_id: { value: '$CHECKLYHQ_ACCID' },
        }
      }
    }
  })
  .use('checklyhq-provider')

let board = await seneca.entity('provider/checklyhq/board')
  .load$('<checklyhq-board-id>')

Console.log('BOARD', board)

board.desc = 'New description'
board = await board.save$()

Console.log('UPDATED BOARD', board)

Install

$ npm install @seneca/checklyhq-provider @seneca/env

Options

• debug : boolean false

Set plugin options when loading with:

seneca.use('ChecklyhqProvider', { name: value, ... })

Note: foo.bar in the list above means { foo: { bar: ... } }

Action Patterns

• role:entity,base:checklyhq,cmd:load,name:repo,zone:provider
• role:entity,base:checklyhq,cmd:save,name:repo,zone:provider
• sys:provider,get:info,provider:checklyhq

Action Descriptions

« role:entity,base:checklyhq,cmd:list,name:repo,zone:provider »

List Checklyhq repository data into an entity.

« role:entity,base:checklyhq,cmd:load,name:repo,zone:provider »

Load Checklyhq repository data into an entity.

« role:entity,base:checklyhq,cmd:save,name:repo,zone:provider »

Update Checklyhq repository data into an entity.

---

« role:entity,base:checklyhq,cmd:remove,name:repo,zone:provider »

Remove Checklyhq repository data from an entity.

---

« sys:provider,get:info,provider:checklyhq »

Get information about the provider.

---