Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Wegalvanize Events API

An Event links a status to handlers. When an event is fired, the associated handlers will be triggered.

Wegalvanize Events API is one of 69 APIs that Wegalvanize publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Events. The published artifact set on APIs.io includes an OpenAPI specification and an API reference.

This API exposes 5 operations across 2 paths, and defines 11 schemas. It is described by OpenAPI 3.0.2, at version 1.1.0.

Requests are made against a single base URL, {protocol}://{server}/v1.

5 operations 2 paths 11 schemas 1 DELETE2 GET1 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.2
API Version
1.1.0
Base URL
https://apis-us.highbond.com/v1
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Wegalvanize Events API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (oauth2) (bearerToken). By default, every request must be authenticated.

  • bearerToken — HighBond offers the industry-standard OAuth 2.0 flow for connecting to the HighBond platform. OAuth 2.0 provides a safe and secure way to access data, while pr…

Paths & Operations 5

Across 2 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 1 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Events 5

An Event links a status to handlers. When an event is fired, the associated handlers will be triggered.

GET
/orgs/{org_id}/events
List Events
getEvents 1 param → 200400401403404
POST
/orgs/{org_id}/events
Create an event
createEvent 1 param body → 201400401403404415422
GET
/orgs/{org_id}/events/{id}
Get an event
getEvent 3 params → 200400401403404
PATCH
/orgs/{org_id}/events/{id}
Update an event
updateEvent 2 params body → 200400401403404415422
DELETE
/orgs/{org_id}/events/{id}
Delete an Event
deleteEvent 2 params → 204400401403404

Schemas 11

The contract defines 11 schemas that model the data the API accepts and returns. The most detailed are HandlerPlainJson (10 properties), Error (5 properties), SingleEventResponse (2 properties), SingleEventCreateUpdateResponse (1 property). Each schema is shown below with its type and property counts.

HandlerConditionsConfigurationOptions
Error
object
5 properties 1 required
HandlerConditionsConfigurationOperatorOptions
Errors
object
1 property
HandlerActionsConfigurationOptions
UpdateEventPayload
object
The data associated with the resource.
1 property 1 required
HandlerPlainJson
object
The plain JSON representation of a Handler.
10 properties
CreateEventPayload
object
The data associated with the resource.
1 property 1 required
SingleEventResponse
object
The data associated with the resource.
2 properties 1 required
SingleEventCreateUpdateResponse
object
The data associated with the resource.
1 property 1 required
MultipleEventsResponse
object
The data associated with the resource.
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

wegalvanize-events-api-openapi.yml Raw ↑

Other APIs Wegalvanize publishes across the network.

Wegalvanize Actions API
Wegalvanize Activities API
Wegalvanize Analyses API
Wegalvanize Attachments API
Wegalvanize Collaborators API
Wegalvanize Collections API
Wegalvanize Compliance Maps API
Wegalvanize Control performance schedules API
Wegalvanize Control test plans API
Wegalvanize Control tests API
Wegalvanize Controls API
Wegalvanize Custom attributes API