Yext WebhooksInstall

Summary

Add a new request webhook to Agreements in Yext by sending metadata and detailed addRequest configuration as JSON.

Inputs

• Meta — Optional metadata including UUID, timestamp, account IDs for tracking the webhook request.
• Add Request (required) — A JSON object specifying the add request details, such as new location data, entity data, and SKUs associated with the agreement.

Output shape

a single JSON response object confirming the creation or status of the add request webhook

Sends a JSON body constructed from the Meta and parsed Add Request fields. Handles batching, timeout, proxy, and SSL options if configured in requestOptions. Response structure follows the Yext API standard for add request webhook creation.

Examples

Example 1: Create a new add request webhook with detailed entity data.

Set 'Meta' with relevant tracking info if needed. Provide a structured JSON for 'Add Request' containing all necessary fields as per Yext's add request schema.