NEnexla
Webhooks

Send many records to Webhook

Send an array of JSON objects. Nexla will treat each object as a unique record for the webhook.

postWebhooksend_many_records

Path parameters

include_headersboolean required

Set this to true if you wish to send any custom headers to be included in the ingested record as part of the request.

The platform will ignore standard headers like Authorization and Content-Type. Any custom headers will be added as a header_<header_name> attribute in the record.

Example: The request header NEX-HEADER: test will be ingested as the attribute header_NEX-HEADER with the value test.

Default value: false

include_url_paramsboolean required

Set this to true if you wish to send any custom query parameters to be included in the ingested records as part of the request.

The platform will ignore standard query parameters like api_key. Any custom query parameters will be added as a url_param_<param_name> attribute in the record.

Example: The request query parameter abc=def will be ingested as the attribute url_param_abc with the value def.

Default value: false

force_schema_detectionboolean required

Usually, the platform performs Nexset schema detection only for the first few records from a new webhook. This is to avoid any unnecessary latencies in webhook record processing.

Set this to true if you wish to enforce any webhook event to trigger schema detection.

Default value: false

Payload

NexsetRecord[] required

Response

Returns the 200 status to indicate that data was received.

datasetIdinteger

Nexset ID of the Nexset to which this record is sent.

processedinteger

Number of records successfully processed by Nexla.

Changes

Webhooks have no change history: a webhook is keyed by its event name rather than a path and method, so no recorded change can name it.