Webhooks Developer Guide

Developer
1

Webhooks Developer Guide [draft]

As of Q3 2024, Developers using Bluescape’s API can now utilize webhooks for more efficient workflow automation. Webhooks allow you to pre-assign a webhook endpoint to call when a specified event happens in a bluescape workspace. Prior to this feature being released, developers had to create GraphQL subscriptions for all events in a workspace and parse the ones they cared about. Webhooks will make it easier to trigger custom workflows with external applications or services to enhance the Bluescape experience.

Enabling webhooks

To utilize webhooks, you will first need to enable them in your Bluescape instance.

For commercial/SaaS customers, reach out to your Bluescape point of contact to enable them for your instance and organization.

For on-prem / private instance customers, you will need to enable webhooks in your bluescape.libsonnet config file as well as issue an org-level CLI command from the admin console.

The bluescape.libsonnet setting to enable webhooks is located at $.sharedConfig.webhooks.enabled and needs to be set to "true".

local kube = import '../../lib/kube.libsonnet';
local EnvironmentBase = import './packageBase.libsonnet';


EnvironmentBase {
  // Per-environment overrides go here
  sharedConfig+: {

    // has to be bluescape in this version
    namespace: 'bluescape',

    // Replace this with the domain you want it installed into
    domain: 'nealr24Q3.domain.com',

    // Replace this with your Cluster Name
    cluster: 'nealr24Q3',

    webhooks+ {
      enabled: "true"
    },
    ...
    ...
    ...

The CLI commands to issue can be found on our community site.

  1. Get the org id from the CLI by calling organizations.
```
   Placeholder
```
  1. Update the feature flag is_webhooks_enabled by calling Organizations update --id=<ORG ID> -i '{"is_webhooks_enabled":<true/false>}'
```
  Placeholder
```
  1. Continue with using webhooks

Available event types

Listening for events

Responding to events

Where to Next?

Not what you were looking for? Reply below or Search the community and discover more Bluescape.