Webhooks

Create webhook

Register a webhook endpoint for event notifications.

post/v1/webhooks

Request

  • Base URL: https://api.onegoodarea.com
  • URL: https://api.onegoodarea.com/v1/webhooks
  • Auth: HTTP bearer

Request body

urlstring uri

Required. HTTPS webhook endpoint URL.

eventsstring[]

Required. Supported: 'signal.changed' (material moves from a portfolio change check) and 'portfolio.feed' (each change-feed entry after a refresh). Unsupported entries are filtered out and duplicates collapsed.

causesstring[]

Optional. Which changes to receive by why they moved: 'source' (the world or its publisher), 'method' (a methodology release, same period), 'source_and_method' (both). Default ['source'].

Example request

{
  "url": "https://example.com/hooks",
  "events": [
    "signal.changed",
    "portfolio.feed"
  ],
  "causes": [
    "source"
  ]
}

Response

Default Response

idstring required
urlstring required
eventsstring[] required
causesstring[] required
secretstring required
created_atstring date-time required

Changes

No recorded changes to this operation across all 2 revisions of this API.