Skip to main content

Generic incoming webhooks

A generic incoming webhook gives you a ready-made Coralogix URL that any application capable of sending an HTTP request can post to. Coralogix generates the URL, binds it to an API key, and stamps every event it receives with the application and subsystem names you pick, so you can start ingesting telemetry without writing shipper code or deploying an agent.

When to use an incoming webhook ​

Incoming webhooks suit low-volume, event-driven sources: CI pipelines, SaaS notifications, status feeds, and internal tools that already know how to post JSON.

Keep these constraints in mind before you point a source at one:

  • Latency. Every request carries its own overhead. For high-traffic sources, send to a standard log endpoint such as singles instead.
  • Payload size. 2 MB per request, measured uncompressed. Compressing the request body does not raise this limit.
  • Rejected requests. Anything larger returns HTTP 413 Payload Too Large, and none of the events in that request are ingested.

What you need ​

  • A Coralogix API key. You can create one while configuring the webhook.
  • An application and subsystem name to route the incoming data.
  • A source application that can send an HTTP request with a JSON or text body.

Create an incoming webhook ​

1.
**Open the Contextual Data catalog**

Navigate to Data Flow, then Contextual Data.

2.
**Add the Generic Webhook integration**

On the Generic Webhook card, select Add.

Contextual Data catalog with the Generic Webhook card selected and its Add button visible

Shows the Contextual Data catalog filtered to push and pull integrations, with the Generic Webhook card highlighted.

3.
**Start a new webhook**

Select Add new. The page lists every webhook already defined in the account, with its URL, application, subsystem, and creation date.

Generic Webhook integration page listing existing webhooks with an Add new button

Shows the Generic Webhook integration page with the table of existing webhooks and the Add new button.

4.
**Fill in the integration details**

Complete every field in the Integration Details panel.

FieldWhat to enter
Webhook NameA name for the webhook.
Your API KeySelect Create new key to generate a key and name it, or supply an existing one.
App Name and Subsystem NameThe application and subsystem names applied to every event this webhook ingests.
Content TypeJSON or Text. JSON accepts request bodies with a content type of application/json or application/x-ndjson.
TimestampGenerate on ingestion stamps each event with the system time at ingestion. Extract from the body reads the timestamp out of the event itself. Select Path (typical for JSON) or Regex (typical for text), then enter the path or expression to extract with.

Generic Webhook integration details form with name, API key, application, content type, and timestamp fields

Shows the integration details form with the Create new key and Generate URL buttons.

5.
**Generate the URL**

Select Generate URL. Coralogix creates the webhook URL for you to copy into your application.

Note

In Secure Mode you can download the URL only once, at the moment you generate it. Afterwards it appears masked in Coralogix.

Connect your application ​

Paste the generated URL into the webhook settings of the source application. In GitLab, for example, it goes in the URL field of the project's webhook settings.

GitLab webhook settings page with the URL field outlined in red

Shows GitLab's webhook settings with the URL field that receives the Coralogix webhook URL.

Last updated on