Uniform.Integrations.Zapier 1.0.41-preview

Uniform.Integrations.Zapier

Zapier integration for the Uniform microservice framework. Supports sending outgoing payloads to Zapier webhook actions and consuming incoming Zapier webhook triggers via the Uniform Bridge.

Installation

dotnet add package Uniform
dotnet add package Uniform.Integrations.Zapier

Setup

Register your webhooks by name using WithZapierModule when bootstrapping your service. The names are keys you choose; their URLs are resolved from config at runtime.

await UniformService<MyService>
    .Initialise()
    .WithModule<RabbitMqModule>()
    .WithZapierModule("order-placed", "user-signed-up")
    .Run();

Outgoing — sending to Zapier

Configuration

For each registered name, set its URL in config:

Set these in appsettings.json or environment variables (use __ as the hierarchy separator, e.g. Uniform__Integrations__Zapier__order-placed__Url). Remote config via the Uniform Licensing UI is recommended so URLs are not baked into your deployments.

On startup, ZapierModule logs a Ready confirmation for each webhook that has a URL configured, or a Warning for any that are missing — so misconfiguration is caught immediately.

Sending a message

Inject IZapierWebhookClient and call by name:

public class OrderPlacedConsumer : IConsumer<OrderPlaced>
{
    private readonly IZapierWebhookClient _zapier;

    public OrderPlacedConsumer(IZapierWebhookClient zapier) => _zapier = zapier;

    public async Task Consume(OrderPlaced message)
    {
        await _zapier.SendMessage("order-placed", $"New order {message.OrderId}");
    }
}

Sending structured data

Use SendPayload to send multiple fields. Each key becomes a separately mappable field inside Zapier:

await _zapier.SendPayload("order-placed", new()
{
    ["orderId"]  = order.Id,
    ["customer"] = order.CustomerName,
    ["total"]    = order.Total
});

Query string parameters

Both SendMessage and SendPayload accept an optional queryString dictionary. These are appended to the webhook URL separately from the JSON body — e.g. https://hooks.zapier.com/...?source=my-service&env=production. This corresponds directly to Zapier's Query String Params field in the webhook action, which is useful for passing routing metadata or context that sits outside the main payload.

Keys and values are automatically percent-encoded using Microsoft.AspNetCore.WebUtilities.QueryHelpers, so no manual escaping is needed.

await _zapier.SendPayload("order-placed", new()
{
    ["orderId"]  = order.Id,
    ["customer"] = order.CustomerName
},
queryString: new()
{
    ["source"] = "order-service",
    ["env"]    = "production"
});

Incoming — receiving from Zapier

Incoming Zapier webhooks are handled by a Uniform Bridge running inside your network. The Bridge exposes a webhook endpoint that Zapier targets, receives the payload, and publishes a ZapierWebhookReceived message into RabbitMQ — no changes required to your service.

Point your Zapier trigger's webhook URL at your Bridge:

POST https://your-bridge/zapier/webhook

The Bridge accepts both application/json and application/x-www-form-urlencoded payloads, as well as query string parameters, normalising everything into a single dictionary.

No registration is required — consumers are discovered automatically by Uniform. See the Uniform Bridge documentation for setup instructions.

Links

• GitHub
• Documentation
• Uniform (main package)