How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

SparkPost Relay Webhooks API

The Relay Webhooks API from SparkPost — 3 operation(s) for relay webhooks.

SparkPost Relay Webhooks API is one of 12 APIs that SparkPost publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Relay Webhooks. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 6 operations across 3 paths, and defines 5 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

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

6 operations 3 paths 5 schemas 1 DELETE2 GET2 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://api.sparkpost.com/api/v1
Authentication
API Key
License
Resource Areas
1

Authentication & Security 1

SparkPost Relay Webhooks API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (ApiKeyAuth). By default, every request must be authenticated.

Paths & Operations 6

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

Relay Webhooks 6
POST
/relay-webhooks
Create a Relay Webhook
createRelayWebhook body → 200400409422
GET
/relay-webhooks
List All Relay Webhooks
listRelayWebhooks → 200401
GET
/relay-webhooks/{id}
Retrieve a Relay Webhook
getRelayWebhook 1 param → 200401404
PUT
/relay-webhooks/{id}
Update a Relay Webhook
updateRelayWebhook 1 param body → 200400404409
DELETE
/relay-webhooks/{id}
Delete a Relay Webhook
deleteRelayWebhook 1 param → 200404
POST
/relay-webhooks/{id}/validate
Validate a Relay Webhook
validateRelayWebhook 1 param → 200

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are RelayWebhookRequest (7 properties), RelayWebhookUpdateRequest (7 properties), RelayWebhookDetails (6 properties), ErrorResponse (1 property). Each schema is shown below with its type and property counts.

RelayWebhookUpdateRequest
object
7 properties
RelayWebhookDetails
object
6 properties
RelayWebhookResponse
object
1 property
ErrorResponse
object
1 property
RelayWebhookRequest
object
7 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

sparkpost-relay-webhooks-api-openapi.yml Raw ↑

Other APIs SparkPost publishes across the network.

SparkPost DKIM Keys API
SparkPost Events API
SparkPost Inbound Domains API
SparkPost Metrics API
SparkPost Recipient Lists API
SparkPost Sending Domains API
SparkPost Subaccounts API
SparkPost Suppression List API
SparkPost Templates API
SparkPost Transmissions API
SparkPost Webhooks API
Where this information came from

This is an independent, third-party profile of SparkPost Relay Webhooks API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.