Webhooks allow you to build or set up GitHub Apps Applications which subscribe to certain events on GitHub Scopear.com. Webhooks provide a way for notifications to be delivered to an external web server whenever certain actions occur on a repository or an organization. Also called a service hook.
...
In this article
Enabling webhooks for
...
your
...
You can configure webhooks to alert you when you receive new sponsorships or existing sponsors make changes to their sponsorships.
In this article
To monitor changes to your sponsorships, such as cancellations at the end of a pay period, you can create webhooks for your sponsored user or organization account. When you set up a webhook for your sponsored user or organization account, you'll receive updates when sponsorships are created, edited, or deleted. For more information, see the sponsorship webhook event.
Managing webhooks for your sponsored user account
...
organization
List of available webhooks
Webhook format
Enabling webhooks for your organization
Contact api.support@scopear.com in order to setup webhooks for your organization.
You’ll need to provide a base url that you would like scope to publish event notifications to, e.g. something like https://yourapplication.com/hooks/scopear
List of available webhooks
The following events trigger outbound webhooks. Contact api.support@scopear.com in order to request additional webhook events.
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:
| Code Block |
|---|
{
"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 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.