Newscatcher Webhooks API
Operations to create and manage reusable webhook endpoints.A webhook is a named HTTP endpoint that receives a POST notificationwhen a job or monitor completes. Create webhooks once at the organizationlevel and attach them to any number of jobs or monitors via `webhook_ids`.Supports Slack, Microsoft Teams, and generic HTTP targets with configurabledelivery modes, authentication, and headers.
Newscatcher Webhooks API is one of 16 APIs that Newscatcher 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 and API documentation.
This API exposes 11 operations across 7 paths, and defines 26 schemas. It is described by OpenAPI 3.0.3, at version 1.2.0.
Requests are made against a single base URL, https://local-news.newscatcherapi.com.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Newscatcher Webhooks API declares
1 security scheme
for authenticating requests.
An API key is passed in the header as x-api-token (ApiKeyAuth).
By default, every request must be authenticated.
ApiKeyAuth— API Key to authenticate requests. To access the API, include your API key in the x-api-token header. To obtain your API key, complete the [form](https://www.ne…
Paths & Operations 11
Across 7 paths, the API surfaces 11 operations — 2 DELETE, 5 GET, 1 PATCH, 3 POST. Each is listed below with its method, path, parameters, and response codes.
Operations to create and manage reusable webhook endpoints. A webhook is a named HTTP endpoint that receives a POST notification when a job or monitor completes. Create webhooks o…
Schemas 26
The contract defines 26 schemas that model the data the API accepts and returns. The most detailed are WebhookResponseDto (14 properties), DeliveryHistoryItemDto (11 properties), UpdateWebhookRequestDto (10 properties), CreateWebhookRequestDto (9 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Newscatcher 12
Other APIs Newscatcher publishes across the network.