Webhook Payload Variables

When using the Generic Webhook connector or the REST API to publish articles from iContentForge, you can access a set of predefined variables within the article payload. These variables contain the generated content and its associated metadata, which you can map to your custom CMS or application fields.

This reference details all 16 available variables, their data types, descriptions, and example values.

Variable Reference Table

The following variables are included in the webhook payload when an article's status changes to ready or published.

Using Variables in JSON Templates

In the Generic Webhook connector configuration, you can use a Template Mode to construct a custom JSON payload. Insert variables using double curly braces: {{variableName}}.

Example Payload Template

{
  "post": {
    "title": "{{title}}",
    "content": "{{html}}",
    "seo": {
      "metaTitle": "{{metaTitle}}",
      "description": "{{metaDescription}}",
      "focusKeyword": "{{keyword}}"
    },
    "taxonomy": {
      "categories": {{categories}},
      "tags": {{tags}}
    },
    "stats": {
      "words": {{wordCount}},
      "readTime": {{readingTime}}
    },
    "slug": "{{slug}}",
    "published_at": "{{publishedAt}}",
    "author": "{{authorName}}",
    "source": "{{projectName}}"
  }
}

Field Mapping vs. Template Mode

The Generic Webhook connector offers two primary methods for sending data to your endpoint:

1. Field Mapping Mode This is a simpler, form-based approach. You provide your endpoint URL and then map individual iContentForge variables to the specific field names (keys) your API expects.

• Best for: Standard REST APIs where you send JSON with flat key-value pairs (e.g., { "title": "value", "body": "value" }).
• Advantage: No JSON syntax to manage; less prone to configuration errors.

2. Template Mode This gives you full control. You write the complete JSON payload structure, embedding variables where needed using the {{variableName}} syntax.

• Best for:
  • APIs requiring nested JSON objects.
  • APIs with specific, unchanging root-level keys.
  • When you need to combine variables with static text or values.
  • Sending data to serverless functions or middleware that reformat the payload.
• Advantage: Maximum flexibility to match any API specification.

Next Steps

• Learn how to set up the connector: Generic Webhook Integration
• Understand the article generation workflow: Article Statuses & Drip Feed
• Explore other publishing options: CMS Integrations Overview