Skip to main content

Webhook Rocket

This rocket adds a Webhook to your Booster application. When the webhook is called, a function will be executed in your Booster application with request as a parameter.

info

GitHub Repo

Supported Providers​

  • Azure Provider
  • Local Provider

Usage​

Add your rocket to your application in the Booster configuration file:

config.rockets = [buildBoosterWebhook(config).rocketForAzure()]

Then declare the function to initialize the BoosterWebhook:

function buildBoosterWebhook(config: BoosterConfig): BoosterWebhook {
    return new BoosterWebhook(config, [
        {
            origin: 'test',
            handlerClass: TestHandler,
        },
        {
            origin: 'other',
            handlerClass: FacebookHandler,
        },
    ])
}
info

Parameters:

  • origin: Identify the webhook. It will be also the name of the endpoint that will be created.
  • handlerClass: A class with a handle method to handle the request.

The handle method should be like this one:

export class TestHandler {

  constructor() {
  }

  public static async handle(webhookEventInterface: WebhookEvent, register: Register): Promise<WebhookHandlerReturnType> {
    if (validationFails()) {
      throw new InvalidParameterError("Error message");
    }
    return Promise.resolve({
      body: { name: "my_name" }
    });
  }
}

Return type​

Handle methods return a promise of WebhookHandlerReturnType or void. This object contains the headers and body to be returned as response.

Example:

  public static async handle(webhookEventInterface: WebhookEvent, register: Register): Promise<WebhookHandlerReturnType> {
    return Promise.resolve({
      body: 'ok',
      headers: {
        Test: 'test header',
      },
    })
  }

Demo​

curl --request POST 'http://localhost:3000/webhook/command?param1=testvalue'

The webhookEventInterface object will be similar to this one:

{
  origin: 'test',
  method: 'POST',
  url: '/test?param1=testvalue',
  originalUrl: '/webhook/test?param1=testvalue',
  headers: {
    accept: '*/*',
    'cache-control': 'no-cache',
    host: 'localhost:3000',
    'accept-encoding': 'gzip, deflate, br',
    connection: 'keep-alive',
    'content-length': '0'
  },
  query: { param1: 'testvalue' },
  params: {},
  rawBody: undefined,
  body: {}
}