Ping Email Channel Provider
Configuration
The configuration steps are explained in the ping_email configuration page.
Usage
1. When configured with
{
"url": "https://example.com/webhook"
}
2. With a channel token
{
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"url": {
"description": "URL to ping",
"format": "uri",
"maxLength": 100,
"minLength": 1,
"type": "string"
}
},
"required": [
"url"
],
"type": "object"
}
3. With Broadcast
{
"action_url": "https://example.com",
"category": "example",
"content": "I come from broadcast",
"custom_attributes": {},
"id": "d1b3b3b3-3b3b-3b3b-3b3b-3b3b3b3b3b3b",
"overrides": {},
"recipients": [
{
"custom_attributes": {
"plan": "enterprise",
"preferred_pronoun": "They",
"pricing_version": "v10"
},
"email": "test@example.com",
"external_id": "83d987a-83fd034",
"first_name": "Person",
"last_name": "Doe",
"phone_numbers": [
"+1 5005550001"
]
}
],
"title": "Hello, World!",
"topic": "example"
}
The channel handler triggers a HTTP request
POST https://example.com/webhook
With payload
{
"notifications": [
{
"action_url": "https://example.com",
"category": null,
"content": "I come from broadcast",
"custom_attributes": {},
"id": "00000000-0000-0000-0000-000000000000",
"overrides": {},
"recipient": {
"created_at": "0001-01-01T00:00:00Z",
"custom_attributes": null,
"email": null,
"external_id": null,
"first_name": null,
"id": "00000000-0000-0000-0000-000000000000",
"last_name": null,
"last_notified_at": null,
"last_seen_at": null,
"updated_at": "0001-01-01T00:00:00Z"
},
"title": "Hello, World!",
"topic": null,
"updated_at": "0001-01-01T00:00:00Z"
}
],
"total": 1
}