Pre-Deployment

1) Install the Serverless Framework globally

  npm install serverless -g 

2) Install dependencies using Node Package Manager

  npm install 

3) Create a .env file :

Note: Ensure these values are safely stored and are NOT public.

  CHAINLINK_ACCESS_KEY=<Your EI Access Key>
  CHAINLINK_ACCESS_SECRET=<Your EI Secret>

Deployment

Deploy service using serverless:

Note: Ensure You have configured you Serverless CLI to use your AWS ACCESS KEY and SECRET KEY with the appropriate permissions to deploy.

  sls deploy

API Reference

Health Check

  GET https://
   
    /
   

Job Registration (called by CL node when Job Spec is created)

  POST https://
   
    /
   

Example of a valid Job Spec :

type = "webhook"
schemaVersion = 1
name = "job-1"
externalJobID = "unique-external-job-id" # you can pre-define it or just have the node auto generate one for you at creation by removing the attribute from your job spec
externalInitiators = [
  { name = "name-of-your-ei-on-your node", spec = "{\"jobName\": \"job-1\"}" }

]
observationSource = """
    parse_request  [type="jsonparse" path="foo" data="$(jobRun.requestBody)"]


    parse_request 
"""