Skip to main content
POST
/
catchAll
/
webhooks
Create webhook
curl --request POST \
  --url https://catchall.newscatcherapi.com/catchAll/webhooks \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "name": "Layoffs Alert",
  "url": "https://hooks.slack.com/services/T000/B000/xxx",
  "type": "slack",
  "delivery_mode": "full"
}
'
{
  "success": true,
  "message": "Webhook created successfully.",
  "webhook": {
    "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "name": "Layoffs Alert",
    "url": "https://hooks.slack.com/services/T000/B000/xxx",
    "type": "slack",
    "delivery_mode": "full",
    "method": "POST",
    "headers": {},
    "params": {},
    "formatter_config": null,
    "is_active": true,
    "organization_id": "org-uuid-here",
    "created_by_user_id": "user-uuid-here",
    "created_at": "2026-05-18T10:00:00Z",
    "updated_at": "2026-05-18T10:00:00Z"
  }
}

Documentation Index

Fetch the complete documentation index at: https://newscatcherinc-docs.mintlify.dev/docs/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
x-api-key
string
header
required

API key for authentication.

Body

application/json
​
name
string
required

Human-readable label for this webhook.

Example:

"Layoffs Alert"

​
url
string<uri>
required

Destination URL that receives the payload. Must use HTTPS. IP addresses are not accepted.

Type-specific URL requirements:

  • slack: Must start with https://hooks.slack.com/.
  • teams: Hostname must match *.webhook.office.com or *.webhook.office365.com.
  • generic: Any valid HTTPS domain.
  • custom: Any valid HTTPS domain.

When type is omitted, it is auto-detected from the URL.

Example:

"https://hooks.slack.com/services/T000/B000/xxx"

​
type
enum<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 https://hooks.slack.com/.
  • teams: Sends a formatted Microsoft Teams Adaptive Card. URL hostname must match *webhook.office.com or *.webhook.office365.com.
  • custom: Sends a transformed payload using the configuration in formatter_config. Requires formatter_config to be set.

When type is omitted, it is auto-detected from the URL.

Available options:
generic,
slack,
teams,
custom
​
delivery_mode
enum<string>

Delivery mode for webhook payloads.

  • full: Sends all records in a single request on each trigger.
  • per_record: Sends one request per record. For large result sets, this may generate many requests.
Available options:
full,
per_record
​
method
enum<string>

HTTP method used for webhook delivery.

Available options:
GET,
POST,
PUT,
PATCH,
DELETE
​
headers
object

Custom HTTP headers forwarded with each delivery.

​
params
object

Query parameters appended to the webhook URL.

​
auth
object

Authentication forwarded with each delivery. Supported types:

  • bearer: Adds an Authorization: Bearer <token> header.
  • api_key: Adds a custom header with the specified name and value.
  • basic: Adds an Authorization: Basic <credentials> header.
​
formatter_config
object

Custom payload transformation configuration. Required only when type is custom.

Response

Webhook created successfully.

​
success
boolean
required

True if the webhook was created; false otherwise.

Example:

true

​
message
string
required

Human-readable result message.

Example:

"Webhook created successfully."

​
webhook
object

The created webhook object.