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

Whiplash Notification Subscriptions API

Webhook subscription management — list, create, count, retrieve, update, delete, and test

Whiplash Notification Subscriptions API is one of 10 APIs that Whiplash publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Notification Subscriptions. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, and rate-limit docs.

This API exposes 7 operations across 4 paths, and defines 3 schemas. It is described by OpenAPI 3.0.3, at version 2.0.

Requests are made against a single base URL, https://api.getwhiplash.com.

7 operations 4 paths 3 schemas 1 DELETE3 GET2 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
2.0
Base URL
https://api.getwhiplash.com
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Whiplash Notification Subscriptions API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (OAuth2) (bearerAuth). By default, every request must be authenticated.

  • bearerAuth — OAuth 2.0 Bearer token. Obtain via authorization code or client credentials flow. See https://help.whiplash.com/hc/en-us/articles/360050870691-Authentication-f…

Paths & Operations 7

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

Notification Subscriptions 7

Webhook subscription management — list, create, count, retrieve, update, delete, and test

GET
/v2/notification_subscriptions
List notification subscriptions
listNotificationSubscriptions 2 params → 200401
POST
/v2/notification_subscriptions
Create a notification subscription
createNotificationSubscription body → 201401422
GET
/v2/notification_subscriptions/count
Count notification subscriptions
countNotificationSubscriptions → 200401
GET
/v2/notification_subscriptions/{id}
Retrieve a notification subscription
getNotificationSubscription 1 param → 200401404
PUT
/v2/notification_subscriptions/{id}
Update a notification subscription
updateNotificationSubscription 1 param body → 200401404
DELETE
/v2/notification_subscriptions/{id}
Delete a notification subscription
deleteNotificationSubscription 1 param → 204401404
POST
/v2/notification_subscriptions/{id}/test
Test a notification subscription
testNotificationSubscription 1 param → 200401404

Schemas 3

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

ErrorResponse
object
1 property
CountResponse
object
1 property
NotificationSubscriptionInput
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

whiplash-notification-subscriptions-api-openapi.yml Raw ↑

Other APIs Whiplash publishes across the network.

Whiplash Bundle Items API
Whiplash Consumer Returns API
Whiplash Customers API
Whiplash Documents API
Whiplash Items API
Whiplash Notification Events API
Whiplash Orders API
Whiplash Shipnotices API
Whiplash Simulate API