Is AI recommending you? Ask Contentstack Canoe for free
Is AI recommending your brand? Find out with Contentstack Canoe for free
Contentstack.comAcademyLogin
CS-log-dark.svgCS-log-dark.svg
  • Changelog
  • APIs
  • SDKs

Platform

  • Solution Center
  • Marketplace
  • Changelog
  • Developers & IT
  • Business users
  • Digital leaders
  • Developer Fast Track
  • Plans & Pricing

Solutions

  • Retail
  • Travel and tourism
  • Financial services
  • Technology
  • Manufacturing
  • E-commerce
  • Localization
  • Personalization
  • Portals and knowledge bases

Resources

  • Academy
  • Docs
  • Contentstack for Developers
  • Product updates
  • Contentstack on Contentstack
  • Blog
  • Insights and analyst reports
  • The Forrester Wave™: Digital Experience Platforms, Q4 2025
  • Webinars
  • Podcasts
  • Glossary
  • Content generative library
  • Community
  • Headless CMS
  • Composable AXP
  • Personalization
  • CDP

Customers

  • Case Studies
  • Customer Care
  • Contentstack Experience Awards
  • Customer support

Partners

  • Overview
  • Find a partner
  • Login

Company

  • About us
  • News
  • Customer support portal
  • Contact

Social

  • Facebook
  • LinkedIn
  • Instagram
  • GitHub
  • YouTube
  • Discord
  • X
LegalTermsPrivacyTrust Center

Cookie settings

Copyright © 2026 Contentstack Inc. All rights reserved.
/
  1. Home
  2. APIs
  3. Lytics API
  4. Jobs
  5. Webhook Triggers Free

Webhook Triggers Free

markdownView as Markdown

Create and manage data import and export jobs.

WebhookTriggersFree: Create job

POSThttps://api.lytics.io/v2/job/webhook-triggers-free

Create a WebhookTriggersFree job

Sample Request
123456789101112131415161718192021222324252627282930313233
{
  "auth_ids": [
    "string"
  ],
  "config": {
    "audience_events": "enters_only",
    "batch_flush_duration": 0,
    "batch_requests": true,
    "batch_size": 0,
    "cloudevents": true,
    "cloudevents_source": "string",
    "cloudevents_type": "string",
    "field_changes": [
      "string"
    ],
    "http_method": "GET",
    "include_segs": true,
    "segment_ids": [
      "string"
    ],
    "webhook_url": "string",
    "withbackfill": true,
    "worker_count": 0
  },
  "description": "string",
  "drop_events_during_quiet_window": true,
  "expires_at": "2019-08-24T14:15:22Z",
  "monitoring": {},
  "name": "string",
  "quiet_period": 0,
  "quiet_time_of_day": "string",
  "quiet_timezone": "string"
}
Sample Response
Status|201 Created
12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970
{
  "_meta": {},
  "data": {
    "account_id": "string",
    "anomaly_rule": {
      "aid": 0,
      "checks": [
        {
          "allowable_violations": 0,
          "interval": "string",
          "lookback_count": 0,
          "max_threshold": 0,
          "metric_type": "string",
          "min_threshold": 0,
          "type": "string",
          "variance_pct": 0
        }
      ],
      "created": "string",
      "id": "string",
      "subject_id": "string",
      "subject_type": "string",
      "updated": "string"
    },
    "api_token_auth_id": "string",
    "auth_ids": [
      "string"
    ],
    "config": {
      "audience_events": "enters_only",
      "batch_flush_duration": 0,
      "batch_requests": true,
      "batch_size": 0,
      "cloudevents": true,
      "cloudevents_source": "string",
      "cloudevents_type": "string",
      "field_changes": [
        "string"
      ],
      "http_method": "GET",
      "include_segs": true,
      "segment_ids": [
        "string"
      ],
      "webhook_url": "string",
      "withbackfill": true,
      "worker_count": 0
    },
    "created": "string",
    "deleted": true,
    "description": "string",
    "drop_events_during_quiet_window": true,
    "expires_at": "2019-08-24T14:15:22Z",
    "id": "string",
    "meta": {},
    "monitoring": {},
    "name": "string",
    "quiet_period": 0,
    "quiet_time_of_day": "string",
    "quiet_timezone": "string",
    "sleep_until": "string",
    "status": "runnable",
    "updated": "string",
    "user_id": "string",
    "workflow": "string",
    "workflow_id": "string"
  },
  "request_id": "string",
  "status": 0
}

WebhookTriggersFree: Get job

GEThttps://api.lytics.io/v2/job/webhook-triggers-free/{id}

Get the summary of a WebhookTriggersFree job

Sample Response
Status|200 OK
12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970
{
  "_meta": {},
  "data": {
    "account_id": "string",
    "anomaly_rule": {
      "aid": 0,
      "checks": [
        {
          "allowable_violations": 0,
          "interval": "string",
          "lookback_count": 0,
          "max_threshold": 0,
          "metric_type": "string",
          "min_threshold": 0,
          "type": "string",
          "variance_pct": 0
        }
      ],
      "created": "string",
      "id": "string",
      "subject_id": "string",
      "subject_type": "string",
      "updated": "string"
    },
    "api_token_auth_id": "string",
    "auth_ids": [
      "string"
    ],
    "config": {
      "audience_events": "enters_only",
      "batch_flush_duration": 0,
      "batch_requests": true,
      "batch_size": 0,
      "cloudevents": true,
      "cloudevents_source": "string",
      "cloudevents_type": "string",
      "field_changes": [
        "string"
      ],
      "http_method": "GET",
      "include_segs": true,
      "segment_ids": [
        "string"
      ],
      "webhook_url": "string",
      "withbackfill": true,
      "worker_count": 0
    },
    "created": "string",
    "deleted": true,
    "description": "string",
    "drop_events_during_quiet_window": true,
    "expires_at": "2019-08-24T14:15:22Z",
    "id": "string",
    "meta": {},
    "monitoring": {},
    "name": "string",
    "quiet_period": 0,
    "quiet_time_of_day": "string",
    "quiet_timezone": "string",
    "sleep_until": "string",
    "status": "runnable",
    "updated": "string",
    "user_id": "string",
    "workflow": "string",
    "workflow_id": "string"
  },
  "request_id": "string",
  "status": 0
}

WebhookTriggersFree: Update job

PUThttps://api.lytics.io/v2/job/webhook-triggers-free/{id}

Update a WebhookTriggersFree job

Sample Request
123456789101112131415161718192021222324252627282930313233
{
  "auth_ids": [
    "string"
  ],
  "config": {
    "audience_events": "enters_only",
    "batch_flush_duration": 0,
    "batch_requests": true,
    "batch_size": 0,
    "cloudevents": true,
    "cloudevents_source": "string",
    "cloudevents_type": "string",
    "field_changes": [
      "string"
    ],
    "http_method": "GET",
    "include_segs": true,
    "segment_ids": [
      "string"
    ],
    "webhook_url": "string",
    "withbackfill": true,
    "worker_count": 0
  },
  "description": "string",
  "drop_events_during_quiet_window": true,
  "expires_at": "2019-08-24T14:15:22Z",
  "monitoring": {},
  "name": "string",
  "quiet_period": 0,
  "quiet_time_of_day": "string",
  "quiet_timezone": "string"
}
Sample Response
Status|200 OK
12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970
{
  "_meta": {},
  "data": {
    "account_id": "string",
    "anomaly_rule": {
      "aid": 0,
      "checks": [
        {
          "allowable_violations": 0,
          "interval": "string",
          "lookback_count": 0,
          "max_threshold": 0,
          "metric_type": "string",
          "min_threshold": 0,
          "type": "string",
          "variance_pct": 0
        }
      ],
      "created": "string",
      "id": "string",
      "subject_id": "string",
      "subject_type": "string",
      "updated": "string"
    },
    "api_token_auth_id": "string",
    "auth_ids": [
      "string"
    ],
    "config": {
      "audience_events": "enters_only",
      "batch_flush_duration": 0,
      "batch_requests": true,
      "batch_size": 0,
      "cloudevents": true,
      "cloudevents_source": "string",
      "cloudevents_type": "string",
      "field_changes": [
        "string"
      ],
      "http_method": "GET",
      "include_segs": true,
      "segment_ids": [
        "string"
      ],
      "webhook_url": "string",
      "withbackfill": true,
      "worker_count": 0
    },
    "created": "string",
    "deleted": true,
    "description": "string",
    "drop_events_during_quiet_window": true,
    "expires_at": "2019-08-24T14:15:22Z",
    "id": "string",
    "meta": {},
    "monitoring": {},
    "name": "string",
    "quiet_period": 0,
    "quiet_time_of_day": "string",
    "quiet_timezone": "string",
    "sleep_until": "string",
    "status": "runnable",
    "updated": "string",
    "user_id": "string",
    "workflow": "string",
    "workflow_id": "string"
  },
  "request_id": "string",
  "status": 0
}
Hide Parameters

Query Parameters

account_idoptionalstring

The account ID. Defaults to the user's default account.

Headers

Authorizationoptionalstring

Body Parameters

auth_idsoptionalstring[]

Authorization IDs associated with the Job

configrequiredobject

Job configuration, unique per-workflow

config.audience_eventsoptionalstring

Select which type of audience trigger events to send webhooks

One of: enters_only, exits_only

config.batch_flush_durationoptionalinteger

If Batch Events is selected, specify the duration in seconds to wait before sending a batch (when batch does not hit the batch size). If left empty, the default flush duration is 5 seconds. Maximum is 300 seconds.

config.batch_requestsoptionalboolean

Select to batch user events, and send as an array of events in the payload. Batches will be sent every 5 seconds or immediately when the batch size specified below is hit first

config.batch_sizeoptionalinteger

If Batch Events is selected, specify the max number of user events to be sent in each batch. If left empty, the default batch size is 10

config.cloudeventsoptionalboolean
config.cloudevents_sourceoptionalstring
config.cloudevents_typeoptionalstring
config.field_changesoptionalstring[]

Select up to 75 user fields to trigger user change events. For any user in the exported audience, if any of the selected field values change, then the user field change event will be sent to the webhook.

config.http_methodoptionalstring

Select the HTTP method to use for the webhook request. If not provided, the default method is POST.

One of: GET, POST, PUT, PATCH

config.include_segsoptionalboolean

Select to include the entity's audience membership as a field on the payload called 'segments_all'

config.segment_idsrequiredstring[]
config.webhook_urlrequiredstring
config.withbackfilloptionalboolean

Add users who already exist in the selected Lytics audience

config.worker_countoptionalinteger

Set the max number simultaneous webhooks calls that can be handled at once (max 20)

descriptionoptionalstring

A user-defined description

drop_events_during_quiet_windowoptionalboolean
expires_atoptionalstring (date-time)
monitoringoptionalobject

Inline monitoring config. On write: omit to keep, null to clear, or a config to set.

namerequiredstring

A user-defined name

quiet_periodoptionalinteger
quiet_time_of_dayoptionalstring
quiet_timezoneoptionalstring
Hide Parameters

URL Parameters

idrequiredstring

The Job ID

Query Parameters

account_idoptionalstring

The account ID. Defaults to the user's default account.

Headers

Authorizationoptionalstring

Hide Parameters

URL Parameters

idrequiredstring

The Job ID

Query Parameters

account_idoptionalstring

The account ID. Defaults to the user's default account.

Headers

Authorizationoptionalstring

Body Parameters

auth_idsoptionalstring[]

Authorization IDs associated with the Job

configrequiredobject

Job configuration, unique per-workflow

config.audience_eventsoptionalstring

Select which type of audience trigger events to send webhooks

One of: enters_only, exits_only

config.batch_flush_durationoptionalinteger

If Batch Events is selected, specify the duration in seconds to wait before sending a batch (when batch does not hit the batch size). If left empty, the default flush duration is 5 seconds. Maximum is 300 seconds.

config.batch_requestsoptionalboolean

Select to batch user events, and send as an array of events in the payload. Batches will be sent every 5 seconds or immediately when the batch size specified below is hit first

config.batch_sizeoptionalinteger

If Batch Events is selected, specify the max number of user events to be sent in each batch. If left empty, the default batch size is 10

config.cloudeventsoptionalboolean
config.cloudevents_sourceoptionalstring
config.cloudevents_typeoptionalstring
config.field_changesoptionalstring[]

Select up to 75 user fields to trigger user change events. For any user in the exported audience, if any of the selected field values change, then the user field change event will be sent to the webhook.

config.http_methodoptionalstring

Select the HTTP method to use for the webhook request. If not provided, the default method is POST.

One of: GET, POST, PUT, PATCH

config.include_segsoptionalboolean

Select to include the entity's audience membership as a field on the payload called 'segments_all'

config.segment_idsrequiredstring[]
config.webhook_urlrequiredstring
config.withbackfilloptionalboolean

Add users who already exist in the selected Lytics audience

config.worker_countoptionalinteger

Set the max number simultaneous webhooks calls that can be handled at once (max 20)

descriptionoptionalstring

A user-defined description

drop_events_during_quiet_windowoptionalboolean
expires_atoptionalstring (date-time)
monitoringoptionalobject

Inline monitoring config. On write: omit to keep, null to clear, or a config to set.

namerequiredstring

A user-defined name

quiet_periodoptionalinteger
quiet_time_of_dayoptionalstring
quiet_timezoneoptionalstring