Enabling Webhooks

This document outlines the steps to enable webhooks feature.

To use webhooks feature in Scalev, you must enable it in your account and register your webhook URL.

  1. Create Scalev account if you don't have one. Register here.
  2. Be at one of the subscription plans that allow webhooks. Hint: it's only available for Basic plan and above. For more information about our subscription plans, you can read this page.
  3. Create a valid public endpoint in your app / system that will receive webhook requests from Scalev.
  4. Go to Settings > Developers > Webhooks. You can see all related information and settings regarding webhooks.
  5. Fill in the required fields for webhooks:
    1. Select all events that you want to listen. Information regarding these events will be provided in this page. If you don't select the events here, Scalev won't send you the events.
    2. Enter your endpoint (from step 3) in the Webhook URL field.
    3. Toggle for ACTIVE or INACTIVE. Turn the toggle on or off depending on your development step at the moment.
      1. If you turn the toggle off, you can save your settings but no actual webhook requests will be sent by Scalev to you.
      2. If you turn the toggle on, Scalev will start sending the events to your endpoint and your webhook will be considered as ACTIVE. When you first save the webhook settings with the toggle on, we send an initial request with the following payload:
        {
          "event": "business.test_event",
          "timestamp": "<ISO_8601_TIMESTAMP>",
          "data": {}
        }
        You must return a response with status code 200, otherwise it will fail and the settings won't be saved. Also, you need to verify the request using the mechanism explained in this page.
  6. Click save.