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

Cachet Gig-Events API

Event actions which are sent by the platform to Cachet involving gig-workers tasks done on the platform

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

Tagged areas include Gig-Events. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 1 operation across 1 path, and defines 2 schemas. It is described by OpenAPI 3.1.0, at version 1.0.0.

Requests are made against 2 base URLs: https://platform-api.cachet.me, https://dev-platorm-api.cachet.me.

1 operations 1 paths 2 schemas 1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0.0
Base URL
https://platform-api.cachet.me
Authentication
API Key, API Key
Contact
Terms of Service
Resource Areas
1

Authentication & Security 2

Cachet Gig-Events API declares 2 security schemes for authenticating requests. An API key is passed in the header as x-api-username (x-api-username). An API key is passed in the header as x-api-key (x-api-key). By default, every request must be authenticated.

  • x-api-username — Username provided by Cachet IT
  • x-api-key — API Key provided by Cachet IT

Paths & Operations 1

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

Gig-Events 1

Event actions which are sent by the platform to Cachet involving gig-workers tasks done on the platform

POST
/create-gig-event
/create-gig-event
post-create-gig-event body → 200401500

Schemas 2

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

CreateGigEventInput
object
Input of the /create-gig-event endpoint
4 properties 4 required
Location
object
Location object
3 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

cachet-gig-events-api-openapi.yml Raw ↑

Other APIs Cachet publishes across the network.

Cachet Connect API
Cachet User API
Cachet Vehicle events API