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

Notyfi webhooks API

The webhooks API from Notyfi — 4 operation(s) for webhooks.

Notyfi webhooks API is one of 5 APIs that Notyfi publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

This API exposes 6 operations across 4 paths, and defines 11 schemas. It is described by OpenAPI 3.1.0, at version 1.2.0.

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

6 operations 4 paths 11 schemas 1 DELETE1 GET1 PATCH3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.2.0
Base URL
https://api.notyfi.com/api/v1
Authentication
HTTP Bearer, API Key
Resource Areas
1

Authentication & Security 2

Notyfi webhooks API declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). An API key is passed in the header as X-Api-Key (apiKeyAuth). By default, every request must be authenticated.

  • bearerAuth — Notyfi API key: Authorization: Bearer notyfimk...
  • apiKeyAuth — Notyfi API key as X-Api-Key.

Paths & Operations 6

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

webhooks 6
GET
/api/v1/webhooks
List outgoing tracker webhook endpoints
list_webhook_endpoints_api_v1_webhooks_get 2 params → 200401429422
POST
/api/v1/webhooks
Register an outgoing tracker webhook
create_webhook_endpoint_api_v1_webhooks_post 2 params body → 201401429403409422503
PATCH
/api/v1/webhooks/{webhook_id}
Update or disable an outgoing tracker webhook
update_webhook_endpoint_api_v1_webhooks__webhook_id__patch 3 params body → 200401429403404409422503
DELETE
/api/v1/webhooks/{webhook_id}
Delete an outgoing tracker webhook
delete_webhook_endpoint_api_v1_webhooks__webhook_id__delete 3 params → 204401429403404422
POST
/api/v1/webhooks/{webhook_id}/rotate-secret
Rotate a webhook signing secret
rotate_webhook_secret_api_v1_webhooks__webhook_id__rotate_secret_post 3 params → 200401429403404409422503
POST
/api/v1/webhooks/{webhook_id}/test
Send a signed webhook.test event now
test_webhook_endpoint_api_v1_webhooks__webhook_id__test_post 3 params → 200401429403404422

Schemas 11

The contract defines 11 schemas that model the data the API accepts and returns. The most detailed are WebhookEndpointCreated (8 properties), WebhookEndpointInfo (7 properties), ValidationError (5 properties), WebhookTestResult (4 properties). Each schema is shown below with its type and property counts.

WebhookEventType
string
Canonical tracker-event changes available to outgoing Notyfi webhooks.
HTTPValidationError
object
1 property
WebhookEndpointCreate
object
Register an account webhook; an empty tracker list subscribes to every owned tracker.
3 properties 1 required
WebhookSecretRotated
object
2 properties 2 required
WebhookEndpointInfo
object
7 properties 4 required
ValidationError
object
5 properties 3 required
WebhookTestResult
object
4 properties 2 required
WebhookEndpointCreated
object
8 properties 5 required
Error
object
The single error response shape for every 4xx/5xx on the contract.
1 property 1 required
ErrorBody
object
3 properties 2 required
WebhookEndpointUpdate
object
Partial endpoint update. An explicit empty tracker list restores account-wide delivery.
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

notyfi-webhooks-api-openapi.yml Raw ↑

Other APIs Notyfi publishes across the network.

Notyfi account API
Notyfi billing API
Notyfi keys API
Notyfi trackers API