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

WorkWave Callback API

Manage the webhook callback URL for asynchronous notifications.

WorkWave Callback API is one of 11 APIs that WorkWave publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

This API exposes 3 operations across 1 path, and defines 2 schemas. It is described by OpenAPI 3.0.1, at version 1.0.

Requests are made against a single base URL, https://wwrm.workwave.com/api/v1.

3 operations 1 paths 2 schemas 1 DELETE1 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
1.0
Base URL
https://wwrm.workwave.com/api/v1
Authentication
API Key, API Key
Terms of Service
Resource Areas
1

Authentication & Security 2

WorkWave Callback API declares 2 security schemes for authenticating requests. An API key is passed in the header as X-WorkWave-Key (ApiKeyHeader). An API key is passed in the query as key (ApiKeyQuery). By default, every request must be authenticated.

  • ApiKeyHeader — API key (UUID) supplied via the X-WorkWave-Key HTTP header.
  • ApiKeyQuery — API key (UUID) supplied via the key query-string parameter. Takes precedence over the header if both are present.

Paths & Operations 3

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

Callback 3

Manage the webhook callback URL for asynchronous notifications.

GET
/callback
Retrieve the configured callback URL.
getCallback → 200
POST
/callback
Set or update the callback URL for asynchronous notifications.
setCallback body → 200400
DELETE
/callback
Remove the configured callback URL.
deleteCallback → 200

Schemas 2

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

Callback
object
1 property
Error
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

workwave-callback-api-openapi.yml Raw ↑

Other APIs WorkWave publishes across the network.

WorkWave Companies API
WorkWave Depots API
WorkWave Drivers API
WorkWave GPS API
WorkWave Orders API
WorkWave Regions API
WorkWave Routes API
WorkWave Territories API
WorkWave Validation API
WorkWave Vehicles API