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

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 Webhook. 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.2.0, at version 1.6.1.

Requests are made against a single base URL, https://catchall.newscatcherapi.com.

11 operations 7 paths 26 schemas 2 DELETE5 GET1 PATCH3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.6.1
Base URL
https://v3-api.newscatcherapi.com/api
Authentication
API Key
Resource Areas
1

Authentication & Security 1

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

  • ApiKeyAuth — API key for authentication.

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.

Webhooks 11

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…

POST
/catchAll/webhooks
Create webhook
createWebhook body → 201403422
GET
/catchAll/webhooks
List webhooks
listWebhooks 3 params → 200403422
GET
/catchAll/webhooks/{webhook_id}
Get webhook
getWebhook 1 param → 200403404422
PATCH
/catchAll/webhooks/{webhook_id}
Update webhook
updateWebhook 1 param body → 200403404422
DELETE
/catchAll/webhooks/{webhook_id}
Delete webhook
deleteWebhook 1 param → 204403404
POST
/catchAll/webhooks/{webhook_id}/test
Test webhook delivery
testWebhook 1 param body → 200403404422
POST
/catchAll/webhooks/{webhook_id}/resources
Assign resource to webhook
assignWebhookResource 1 param body → 200400403404422
GET
/catchAll/webhooks/{webhook_id}/resources
List webhook resources
listWebhookResources 4 params → 200403404422
DELETE
/catchAll/webhooks/{webhook_id}/resources/{resource_type}/{resource_id}
Remove resource from webhook
removeWebhookResource 3 params → 204403404
GET
/catchAll/resources/{resource_type}/{resource_id}/webhooks
List webhooks for resource
listWebhooksForResource 5 params → 200403404422
GET
/catchAll/webhook-history
Get delivery history
getWebhookDeliveryHistory 4 params → 200403404422

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.

CreateWebhookRequestDto
object
9 properties 2 required
ValidationErrorDetail
object
3 properties
UpdateWebhookRequestDto
object
All fields are optional. Only supplied fields are updated.
10 properties
WebhookResourceMappingResponseDto
object
5 properties 4 required
Error
object
1 property
TestWebhookRequestDto
object
1 property
ValidationErrorResponse
object
1 property
UpdateWebhookResponseDto
object
3 properties 2 required
ListWebhookResourcesResponseDto
object
5 properties 5 required
BearerAuthDto
object
2 properties 2 required
TestWebhookResponseDto
object
4 properties 2 required
DeliveryStatus
string
Outcome of a webhook delivery attempt.
ApiKeyAuthDto
object
3 properties 3 required
WebhookType
string
Webhook target type. - generic: Sends the raw result payload to any HTTPS endpoint. - slack: Sends a formatted Slack Block Kit message. URL must start with htt…
DeliveryHistoryItemDto
object
11 properties 8 required
CreateWebhookResponseDto
object
3 properties 2 required
MappableResourceType
string
Resource types that can be assigned to a webhook.
DeliveryMode
string
Delivery mode for webhook payloads. - full: Sends all records in a single request on each trigger. - perrecord: Sends one request per record. For large result…
ListWebhooksResponseDto
object
5 properties 5 required
WebhookResponseDto
object
14 properties 7 required
GetWebhookResponseDto
object
3 properties 2 required
AssignWebhookResourceResponseDto
object
4 properties 1 required
HttpMethod
string
HTTP method used for webhook delivery.
BasicAuthDto
object
3 properties 3 required
DeliveryHistoryResponseDto
object
7 properties 7 required
AssignWebhookResourceRequestDto
object
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

newscatcher-webhooks-api-openapi.yml Raw ↑

Other APIs Newscatcher publishes across the network.

Newscatcher AggregationCount API
Newscatcher Authors API
Newscatcher BreakingNews API
Newscatcher Datasets API
Newscatcher Entities API
Newscatcher Jobs API
Newscatcher LatestHeadlines API
Newscatcher Meta API
Newscatcher Monitors API
Newscatcher Projects API
Newscatcher Search API
Newscatcher SearchBy API
Where this information came from

This is an independent, third-party profile of Newscatcher 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.