/*
* 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.603.1
* Contact: support@zernio.com
* Generated by: https://openapi-generator.tech
*/
use crate::models;
use serde::{Deserialize, Serialize};
/// Webhook : Individual webhook configuration for receiving real-time notifications
#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)]
pub struct Webhook {
/// Unique webhook identifier
#[serde(rename = "_id", skip_serializing_if = "Option::is_none")]
pub _id: Option<String>,
/// Webhook name (for identification)
#[serde(rename = "name", skip_serializing_if = "Option::is_none")]
pub name: Option<String>,
/// Webhook endpoint URL
#[serde(rename = "url", skip_serializing_if = "Option::is_none")]
pub url: Option<String>,
/// Secret key for HMAC-SHA256 signature verification.
#[serde(rename = "secret", skip_serializing_if = "Option::is_none")]
pub secret: Option<String>,
/// Events subscribed to
#[serde(rename = "events", skip_serializing_if = "Option::is_none")]
pub events: Option<Vec<Events>>,
/// Whether webhook delivery is enabled
#[serde(rename = "isActive", skip_serializing_if = "Option::is_none")]
pub is_active: Option<bool>,
/// Timestamp of the last successful webhook delivery. On a healthy endpoint it is refreshed at most once every 10 minutes, so it can trail the most recent delivery by up to 10 minutes.
#[serde(rename = "lastFiredAt", skip_serializing_if = "Option::is_none")]
pub last_fired_at: Option<String>,
/// Consecutive terminal delivery failures. Resets to 0 on any successful delivery. Auto-disable triggers only when the endpoint has had no successful delivery within a 3-day window AND either reaches 20 consecutive terminal failures or has been failing continuously for 3 days. Any success within that window keeps the endpoint enabled, regardless of the count.
#[serde(rename = "failureCount", skip_serializing_if = "Option::is_none")]
pub failure_count: Option<i32>,
/// Custom headers included in webhook requests
#[serde(rename = "customHeaders", skip_serializing_if = "Option::is_none")]
pub custom_headers: Option<std::collections::HashMap<String, String>>,
/// Resource groups this subscription does not receive (opt-out denylist, same vocabulary and semantics as the field on API keys). - Absent or empty: the subscription receives every event in `events` (how subscriptions created before this field behave). - An event whose group is listed is dropped before delivery, even when still in `events`. The same check runs on every replay path (test fire, redelivery, dead-letter requeue). - Edits apply to every event emitted afterwards. Events already queued when the edit landed can still be delivered for up to five minutes after they were enqueued.
#[serde(
rename = "disabledResourceGroups",
skip_serializing_if = "Option::is_none"
)]
pub disabled_resource_groups: Option<Vec<DisabledResourceGroups>>,
/// Profiles this subscription receives events for (allowlist). Absent or empty means every profile, which is how every subscription created before this field existed behaves. - A scoped subscription only gets events attributable to a listed profile. - An aggregate `post.*` event is attributed to the profile of every account the post targets, so a post spanning two scoped endpoints' profiles reaches both. - Events with no profile behind them (`verification.*`, `phone_number.*`, a legacy post whose accounts were deleted) are not delivered to it. Applied when the event is emitted: a redelivery replays a delivery already made to this endpoint, and a test fire ignores the list.
#[serde(rename = "profileIds", skip_serializing_if = "Option::is_none")]
pub profile_ids: Option<Vec<String>>,
/// Connected accounts this subscription receives events for (allowlist). Absent or empty means every account. - Same semantics as `profileIds`, keyed on the account: an aggregate `post.*` event is attributed to every account the post targets. - Events that name no connected account (`verification.*`, `phone_number.*`, and `whatsapp.number.*`, which carry the phone number) are not delivered to an account-scoped subscription. - A subscription with both lists must be satisfied on both. - Applied when the event is emitted. A redelivery replays a delivery already made to this endpoint, and a test fire ignores the list. - The shared WhatsApp sandbox account id (listed by `GET /v1/accounts?includeSandbox=true`) is accepted, so a subscription can receive sandbox traffic only.
#[serde(rename = "accountIds", skip_serializing_if = "Option::is_none")]
pub account_ids: Option<Vec<String>>,
}
impl Webhook {
/// Individual webhook configuration for receiving real-time notifications
pub fn new() -> Webhook {
Webhook {
_id: None,
name: None,
url: None,
secret: None,
events: None,
is_active: None,
last_fired_at: None,
failure_count: None,
custom_headers: None,
disabled_resource_groups: None,
profile_ids: None,
account_ids: None,
}
}
}
/// Events subscribed to
#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)]
pub enum Events {
#[serde(rename = "post.scheduled")]
PostScheduled,
#[serde(rename = "post.published")]
PostPublished,
#[serde(rename = "post.failed")]
PostFailed,
#[serde(rename = "post.partial")]
PostPartial,
#[serde(rename = "post.cancelled")]
PostCancelled,
#[serde(rename = "post.recycled")]
PostRecycled,
#[serde(rename = "post.platform.published")]
PostPlatformPublished,
#[serde(rename = "post.platform.failed")]
PostPlatformFailed,
#[serde(rename = "post.platform.deleted")]
PostPlatformDeleted,
#[serde(rename = "post.tiktok.url_resolved")]
PostTiktokUrlResolved,
#[serde(rename = "post.external.created")]
PostExternalCreated,
#[serde(rename = "post.external.updated")]
PostExternalUpdated,
#[serde(rename = "post.external.deleted")]
PostExternalDeleted,
#[serde(rename = "account.connected")]
AccountConnected,
#[serde(rename = "account.disconnected")]
AccountDisconnected,
#[serde(rename = "account.permissions_changed")]
AccountPermissionsChanged,
#[serde(rename = "account.ads.initial_sync_completed")]
AccountAdsInitialSyncCompleted,
#[serde(rename = "account.ads.sync_failed")]
AccountAdsSyncFailed,
#[serde(rename = "account.ads.sync_recovered")]
AccountAdsSyncRecovered,
#[serde(rename = "analytics.synced")]
AnalyticsSynced,
#[serde(rename = "post.tracking_completed")]
PostTrackingCompleted,
#[serde(rename = "post.authenticity_changed")]
PostAuthenticityChanged,
#[serde(rename = "message.received")]
MessageReceived,
#[serde(rename = "conversation.started")]
ConversationStarted,
#[serde(rename = "conversation.control_changed")]
ConversationControlChanged,
#[serde(rename = "call.received")]
CallReceived,
#[serde(rename = "call.ended")]
CallEnded,
#[serde(rename = "call.failed")]
CallFailed,
#[serde(rename = "call.permission_request")]
CallPermissionRequest,
#[serde(rename = "call.transcript_segment")]
CallTranscriptSegment,
#[serde(rename = "call.recording_ready")]
CallRecordingReady,
#[serde(rename = "message.sent")]
MessageSent,
#[serde(rename = "message.edited")]
MessageEdited,
#[serde(rename = "message.deleted")]
MessageDeleted,
#[serde(rename = "message.delivered")]
MessageDelivered,
#[serde(rename = "message.read")]
MessageRead,
#[serde(rename = "message.played")]
MessagePlayed,
#[serde(rename = "message.failed")]
MessageFailed,
#[serde(rename = "reaction.received")]
ReactionReceived,
#[serde(rename = "referral.received")]
ReferralReceived,
#[serde(rename = "comment.received")]
CommentReceived,
#[serde(rename = "mention.received")]
MentionReceived,
#[serde(rename = "review.new")]
ReviewNew,
#[serde(rename = "review.updated")]
ReviewUpdated,
#[serde(rename = "review.deleted")]
ReviewDeleted,
#[serde(rename = "review.restored")]
ReviewRestored,
#[serde(rename = "lead.received")]
LeadReceived,
#[serde(rename = "conversion.received")]
ConversionReceived,
#[serde(rename = "ad.status_changed")]
AdStatusChanged,
#[serde(rename = "ad.created")]
AdCreated,
#[serde(rename = "ad.updated")]
AdUpdated,
#[serde(rename = "campaign.created")]
CampaignCreated,
#[serde(rename = "campaign.updated")]
CampaignUpdated,
#[serde(rename = "ad_set.created")]
AdSetCreated,
#[serde(rename = "ad_set.updated")]
AdSetUpdated,
#[serde(rename = "ad.review.approved")]
AdReviewApproved,
#[serde(rename = "ad.review.rejected")]
AdReviewRejected,
#[serde(rename = "ad.delivery_issue")]
AdDeliveryIssue,
#[serde(rename = "campaign.budget.depleted")]
CampaignBudgetDepleted,
#[serde(rename = "ad_account.status_changed")]
AdAccountStatusChanged,
#[serde(rename = "campaign.status_changed")]
CampaignStatusChanged,
#[serde(rename = "ad.video.processed")]
AdVideoProcessed,
#[serde(rename = "ad_rule.triggered")]
AdRuleTriggered,
#[serde(rename = "automation.check.completed")]
AutomationCheckCompleted,
#[serde(rename = "automation.action.applied")]
AutomationActionApplied,
#[serde(rename = "automation.action.failed")]
AutomationActionFailed,
#[serde(rename = "automation.action.unknown")]
AutomationActionUnknown,
#[serde(rename = "automation.alert.opened")]
AutomationAlertOpened,
#[serde(rename = "automation.alert.escalated")]
AutomationAlertEscalated,
#[serde(rename = "automation.alert.resolved")]
AutomationAlertResolved,
#[serde(rename = "whatsapp.template.status_updated")]
WhatsappTemplateStatusUpdated,
#[serde(rename = "whatsapp.template.category_updated")]
WhatsappTemplateCategoryUpdated,
#[serde(rename = "whatsapp.account.name_status_updated")]
WhatsappAccountNameStatusUpdated,
#[serde(rename = "whatsapp.account.quality_updated")]
WhatsappAccountQualityUpdated,
#[serde(rename = "whatsapp.account.status_updated")]
WhatsappAccountStatusUpdated,
#[serde(rename = "whatsapp.account.alert_received")]
WhatsappAccountAlertReceived,
#[serde(rename = "whatsapp.contact.identity_changed")]
WhatsappContactIdentityChanged,
#[serde(rename = "whatsapp.automatic_event")]
WhatsappAutomaticEvent,
#[serde(rename = "whatsapp.number.activated")]
WhatsappNumberActivated,
#[serde(rename = "whatsapp.number.declined")]
WhatsappNumberDeclined,
#[serde(rename = "whatsapp.number.action_required")]
WhatsappNumberActionRequired,
#[serde(rename = "whatsapp.number.verification_required")]
WhatsappNumberVerificationRequired,
#[serde(rename = "whatsapp.number.suspended")]
WhatsappNumberSuspended,
#[serde(rename = "whatsapp.number.reactivated")]
WhatsappNumberReactivated,
#[serde(rename = "whatsapp.number.released")]
WhatsappNumberReleased,
#[serde(rename = "whatsapp.number.kyc_submitted")]
WhatsappNumberKycSubmitted,
#[serde(rename = "phone_number.stock_available")]
PhoneNumberStockAvailable,
#[serde(rename = "verification.approved")]
VerificationApproved,
#[serde(rename = "verification.failed")]
VerificationFailed,
#[serde(rename = "api.changelog.published")]
ApiChangelogPublished,
#[serde(rename = "sms.registration.action_required")]
SmsRegistrationActionRequired,
#[serde(rename = "sms.registration.status_updated")]
SmsRegistrationStatusUpdated,
#[serde(rename = "branded_calling.identity.status_updated")]
BrandedCallingIdentityStatusUpdated,
#[serde(rename = "branded_calling.identity.action_required")]
BrandedCallingIdentityActionRequired,
#[serde(rename = "branded_calling.number.status_updated")]
BrandedCallingNumberStatusUpdated,
#[serde(rename = "rcs.agent.status_updated")]
RcsAgentStatusUpdated,
#[serde(rename = "commerce.product.created")]
CommerceProductCreated,
#[serde(rename = "commerce.product.updated")]
CommerceProductUpdated,
#[serde(rename = "commerce.product.deleted")]
CommerceProductDeleted,
#[serde(rename = "commerce.order.created")]
CommerceOrderCreated,
#[serde(rename = "commerce.order.updated")]
CommerceOrderUpdated,
#[serde(rename = "commerce.order.refunded")]
CommerceOrderRefunded,
#[serde(rename = "contact.tag_added")]
ContactTagAdded,
#[serde(rename = "contact.tag_removed")]
ContactTagRemoved,
#[serde(rename = "contact.field_changed")]
ContactFieldChanged,
#[serde(rename = "sequence.enrolled")]
SequenceEnrolled,
#[serde(rename = "sequence.exited")]
SequenceExited,
#[serde(rename = "workflow.run.started")]
WorkflowRunStarted,
#[serde(rename = "workflow.run.completed")]
WorkflowRunCompleted,
#[serde(rename = "workflow.run.failed")]
WorkflowRunFailed,
#[serde(rename = "support.run.completed")]
SupportRunCompleted,
#[serde(rename = "support.run.failed")]
SupportRunFailed,
#[serde(rename = "campaign_submission.received")]
CampaignSubmissionReceived,
#[serde(rename = "campaign_submission.flagged")]
CampaignSubmissionFlagged,
#[serde(rename = "campaign_submission.pending_review")]
CampaignSubmissionPendingReview,
#[serde(rename = "campaign_submission.approved")]
CampaignSubmissionApproved,
#[serde(rename = "campaign_submission.rejected")]
CampaignSubmissionRejected,
#[serde(rename = "creator_campaign.budget_exhausted")]
CreatorCampaignBudgetExhausted,
#[serde(rename = "creator_campaign.closed")]
CreatorCampaignClosed,
#[serde(rename = "campaign_payout.payable")]
CampaignPayoutPayable,
#[serde(rename = "campaign_payout.settled")]
CampaignPayoutSettled,
#[serde(rename = "campaign_payout.failed")]
CampaignPayoutFailed,
#[serde(rename = "campaign_participant.joined")]
CampaignParticipantJoined,
#[serde(rename = "campaign_participant.suspended")]
CampaignParticipantSuspended,
#[serde(rename = "campaign_participant.removed")]
CampaignParticipantRemoved,
#[serde(rename = "account.rate_limited")]
AccountRateLimited,
#[serde(rename = "calendar.event.created")]
CalendarEventCreated,
#[serde(rename = "calendar.event.updated")]
CalendarEventUpdated,
#[serde(rename = "calendar.event.deleted")]
CalendarEventDeleted,
#[serde(rename = "email.sent")]
EmailSent,
#[serde(rename = "email.opened")]
EmailOpened,
#[serde(rename = "email.link_clicked")]
EmailLinkClicked,
#[serde(rename = "email.thread_replied")]
EmailThreadReplied,
#[serde(rename = "email.send_failed")]
EmailSendFailed,
#[serde(rename = "email.bounced")]
EmailBounced,
#[serde(rename = "email.updated")]
EmailUpdated,
#[serde(rename = "email.deleted")]
EmailDeleted,
#[serde(rename = "file.created")]
FileCreated,
#[serde(rename = "file.updated")]
FileUpdated,
#[serde(rename = "file.deleted")]
FileDeleted,
#[serde(rename = "file.picked")]
FilePicked,
#[serde(rename = "contact.updated")]
ContactUpdated,
#[serde(rename = "contact.deleted")]
ContactDeleted,
#[serde(rename = "balance.low")]
BalanceLow,
#[serde(rename = "balance.empty")]
BalanceEmpty,
#[serde(rename = "balance.charged")]
BalanceCharged,
#[serde(rename = "campaign_participant.pending")]
CampaignParticipantPending,
#[serde(rename = "campaign_participant.approved")]
CampaignParticipantApproved,
#[serde(rename = "campaign_participant.denied")]
CampaignParticipantDenied,
#[serde(rename = "campaign_draft.submitted")]
CampaignDraftSubmitted,
#[serde(rename = "campaign_draft.approved")]
CampaignDraftApproved,
#[serde(rename = "campaign_draft.revision_requested")]
CampaignDraftRevisionRequested,
#[serde(rename = "campaign_draft.rejected")]
CampaignDraftRejected,
#[serde(rename = "campaign_sample.requested")]
CampaignSampleRequested,
#[serde(rename = "campaign_sample.approved")]
CampaignSampleApproved,
#[serde(rename = "campaign_sample.shipped")]
CampaignSampleShipped,
#[serde(rename = "campaign_sample.declined")]
CampaignSampleDeclined,
#[serde(rename = "notification.sent")]
NotificationSent,
}
impl Default for Events {
fn default() -> Events {
Self::PostScheduled
}
}
/// Resource groups this subscription does not receive (opt-out denylist, same vocabulary and semantics as the field on API keys). - Absent or empty: the subscription receives every event in `events` (how subscriptions created before this field behave). - An event whose group is listed is dropped before delivery, even when still in `events`. The same check runs on every replay path (test fire, redelivery, dead-letter requeue). - Edits apply to every event emitted afterwards. Events already queued when the edit landed can still be delivered for up to five minutes after they were enqueued.
#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)]
pub enum DisabledResourceGroups {
#[serde(rename = "publishing")]
Publishing,
#[serde(rename = "engagement")]
Engagement,
#[serde(rename = "messages")]
Messages,
#[serde(rename = "contacts")]
Contacts,
#[serde(rename = "analytics")]
Analytics,
#[serde(rename = "ads")]
Ads,
#[serde(rename = "telephony")]
Telephony,
#[serde(rename = "accounts")]
Accounts,
#[serde(rename = "billing")]
Billing,
#[serde(rename = "webhooks")]
Webhooks,
#[serde(rename = "commerce")]
Commerce,
#[serde(rename = "creator_campaigns")]
CreatorCampaigns,
#[serde(rename = "money")]
Money,
#[serde(rename = "calendar")]
Calendar,
#[serde(rename = "files")]
Files,
}
impl Default for DisabledResourceGroups {
fn default() -> DisabledResourceGroups {
Self::Publishing
}
}