Using WebHooks

Webhooks allow you to build or set up Applications which subscribe to certain events on Scopear.com.

Webhooks provide a way for notifications to be delivered to an external web server whenever certain actions occur on an organization. Also called a service hook.

In this article

Enabling webhooks for your organization

Contact support and request that a Scope Admin enable webhooks for your organization.

You’ll need to specify a base url that you wish to receive Scope event notifications, e.g. something like https://yourapplication.com/hooks/scopear

List of available webhooks

The following events currently trigger outbound webhooks. Contact support in order to request the implementation of webhook events additional to those listed below:

• Call.create

• Call.update

• ScenarioSession.create

• ScenarioSession.update

Webhook format

Once webhooks are enabled for your organization, Scope will initiate an HTTP Post to the url you have designated whenever key events occur.

An example payload follows:

{
  "time": "2020-10-20T18:06:02Z",
  "event": "create",
  "type": "resource",
  "data": {
    "resource-id": "OiSSdfK1Su4gwG4zAi2InavDB9eRE9aOnGHYRMG5dqY=",
    "resource-url": "https://cms.scopear.com/api/v3/graphql/object/w4Aa1bjiiNSt1StG11n40b4dYU8lAigrCalO8r6cYwYchxAsWytj-F6wojhI_CsN",
    "resource-type": "scenario"
  }
}

Where, at this time, type can only be resource, and event can only be either create, or update.

Responding to Webhooks

Upon receiving an HTTP POST to your webhook URL, you may want to query the API for additional information associated with the resource.

See Using Global Node Ids and Exploring the Graph.