/*
* Zernio API
*
* API reference for Zernio. Authenticate with a Bearer API key. Base URL: https://zernio.com/api Versioning and deprecation: all endpoints are versioned in the URL path (current version: /v1). Breaking changes only ship in a new path version; existing versions keep working. Deprecated operations are marked 'deprecated: true' in this spec and announced in the changelog (https://zernio.com/changelog) before removal. Errors: every 4xx/5xx response is application/json with a machine-readable 'code' and a human-readable 'error' message (see the ErrorResponse schema). Request ids: responses carry an X-Request-Id header with the id we log the request under. Quote it when reporting a problem. A valid x-request-id you send is reused as that id.
*
* The version of the OpenAPI document: 1.370.0
* Contact: support@zernio.com
* Generated by: https://openapi-generator.tech
*/
use crate::models;
use serde::{Deserialize, Serialize};
/// WebhookPayloadConversationStarted : Fired once when a new conversation begins, in either direction. A conversation starts the first time an account and a contact exchange a message on any DM platform (Instagram, Messenger/Facebook, Telegram, WhatsApp, X, Reddit, Bluesky, SMS, TikTok). Platform-agnostic: one subscription covers every DM platform. `conversation.metadata` (the referral as Meta sent it) and `conversation.adAttribution` (the ad, campaign and ad set from your synced ads) are filled only when the message that created the conversation carried Meta's referral. That holds for WhatsApp Click-to-WhatsApp and Facebook Messenger Click-to-Message, and for ig.me / m.me ref links. On Instagram Click-to-Direct it usually does NOT: Meta creates the thread with the ad post itself, an attachment-only `share` / `ig_post` message with no referral, and attaches the referral to the next message. That conversation.started then has `adAttribution` null and no `metadata`. Read the click from `metadata.ad` and `metadata.referral` on the `message.received` that follows, or from `adAttribution` on `GET /v1/inbox/conversations` and `GET /v1/inbox/conversations/{conversationId}`, which carry it once the referral is stored.
#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)]
pub struct WebhookPayloadConversationStarted {
/// Always true when present: only a sample sent by POST /v1/webhooks/test with an event carries it. Real deliveries never do.
#[serde(rename = "test", skip_serializing_if = "Option::is_none")]
pub test: Option<bool>,
/// Stable webhook event ID: the dedupe key, also sent as the X-Zernio-Event-Id header and identical on every retry and redelivery. It identifies the event only, never an account or other resource.
#[serde(rename = "id")]
pub id: String,
/// The profiles this event belongs to, each with the externalId you set on it (null when none is set). Present on every event tied to a profile and absent on events that belong to none. Events spanning several profiles (a post published to accounts of different profiles) list each once. Use it to route the event to your tenant without storing Zernio profile ids.
#[serde(rename = "profiles", skip_serializing_if = "Option::is_none")]
pub profiles: Option<Vec<models::WebhookProfilesInner>>,
#[serde(rename = "event")]
pub event: Event,
#[serde(rename = "conversation")]
pub conversation: Box<models::WebhookPayloadConversationStartedConversation>,
#[serde(rename = "account")]
pub account: Box<models::InboxWebhookAccount>,
/// When the conversation document was created.
#[serde(rename = "startedAt")]
pub started_at: String,
/// UTC time at which Zernio generated this event (set once when the event payload is built, before delivery is queued). Retries and redeliveries keep the original value, so it reflects the event, not the delivery attempt.
#[serde(rename = "timestamp")]
pub timestamp: String,
}
impl WebhookPayloadConversationStarted {
/// Fired once when a new conversation begins, in either direction. A conversation starts the first time an account and a contact exchange a message on any DM platform (Instagram, Messenger/Facebook, Telegram, WhatsApp, X, Reddit, Bluesky, SMS, TikTok). Platform-agnostic: one subscription covers every DM platform. `conversation.metadata` (the referral as Meta sent it) and `conversation.adAttribution` (the ad, campaign and ad set from your synced ads) are filled only when the message that created the conversation carried Meta's referral. That holds for WhatsApp Click-to-WhatsApp and Facebook Messenger Click-to-Message, and for ig.me / m.me ref links. On Instagram Click-to-Direct it usually does NOT: Meta creates the thread with the ad post itself, an attachment-only `share` / `ig_post` message with no referral, and attaches the referral to the next message. That conversation.started then has `adAttribution` null and no `metadata`. Read the click from `metadata.ad` and `metadata.referral` on the `message.received` that follows, or from `adAttribution` on `GET /v1/inbox/conversations` and `GET /v1/inbox/conversations/{conversationId}`, which carry it once the referral is stored.
pub fn new(
id: String,
event: Event,
conversation: models::WebhookPayloadConversationStartedConversation,
account: models::InboxWebhookAccount,
started_at: String,
timestamp: String,
) -> WebhookPayloadConversationStarted {
WebhookPayloadConversationStarted {
test: None,
id,
profiles: None,
event,
conversation: Box::new(conversation),
account: Box::new(account),
started_at,
timestamp,
}
}
}
///
#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)]
pub enum Event {
#[serde(rename = "conversation.started")]
ConversationStarted,
}
impl Default for Event {
fn default() -> Event {
Self::ConversationStarted
}
}