@getlatedev/node 0.2.1285 → 0.2.1286
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.d.mts +232 -69
- package/dist/index.d.ts +232 -69
- package/dist/index.js +1 -1
- package/dist/index.mjs +1 -1
- package/package.json +1 -1
- package/src/generated/types.gen.ts +242 -69
|
@@ -13273,7 +13273,7 @@ export type Webhook = {
|
|
|
13273
13273
|
/**
|
|
13274
13274
|
* Events subscribed to
|
|
13275
13275
|
*/
|
|
13276
|
-
events?: Array<('post.scheduled' | 'post.published' | 'post.failed' | 'post.partial' | 'post.cancelled' | 'post.recycled' | 'post.platform.published' | 'post.platform.failed' | 'post.platform.deleted' | 'post.tiktok.url_resolved' | 'post.external.created' | 'post.external.updated' | 'post.external.deleted' | 'account.connected' | 'account.disconnected' | 'account.ads.initial_sync_completed' | 'account.ads.sync_failed' | 'account.ads.sync_recovered' | 'analytics.synced' | 'message.received' | 'conversation.started' | 'conversation.control_changed' | 'call.received' | 'call.ended' | 'call.failed' | 'call.permission_request' | 'message.sent' | 'message.edited' | 'message.deleted' | 'message.delivered' | 'message.read' | 'message.played' | 'message.failed' | 'reaction.received' | 'referral.received' | 'comment.received' | 'review.new' | 'review.updated' | 'lead.received' | 'ad.status_changed' | 'ad.review.approved' | 'ad.review.rejected' | 'ad.video.processed' | 'whatsapp.template.status_updated' | 'whatsapp.template.category_updated' | 'whatsapp.account.name_status_updated' | 'whatsapp.account.quality_updated' | 'whatsapp.account.status_updated' | 'whatsapp.account.alert_received' | 'whatsapp.contact.identity_changed' | 'whatsapp.automatic_event' | 'whatsapp.number.activated' | 'whatsapp.number.declined' | 'whatsapp.number.action_required' | 'whatsapp.number.verification_required' | 'whatsapp.number.suspended' | 'whatsapp.number.reactivated' | 'whatsapp.number.released' | 'whatsapp.number.kyc_submitted' | 'phone_number.stock_available' | 'verification.approved' | 'verification.failed' | 'api.changelog.published' | 'sms.registration.action_required' | 'sms.registration.status_updated' | 'branded_calling.identity.status_updated' | 'branded_calling.identity.action_required' | 'branded_calling.number.status_updated' | 'rcs.agent.status_updated' | 'commerce.product.created' | 'commerce.product.updated' | 'commerce.product.deleted' | 'commerce.order.created' | 'commerce.order.updated' | 'commerce.order.refunded' | 'contact.tag_added' | 'contact.tag_removed' | 'contact.field_changed' | 'sequence.enrolled' | 'sequence.exited' | 'workflow.run.started' | 'workflow.run.completed' | 'workflow.run.failed' | 'support.run.completed' | 'support.run.failed')>;
|
|
13276
|
+
events?: Array<('post.scheduled' | 'post.published' | 'post.failed' | 'post.partial' | 'post.cancelled' | 'post.recycled' | 'post.platform.published' | 'post.platform.failed' | 'post.platform.deleted' | 'post.tiktok.url_resolved' | 'post.external.created' | 'post.external.updated' | 'post.external.deleted' | 'account.connected' | 'account.disconnected' | 'account.ads.initial_sync_completed' | 'account.ads.sync_failed' | 'account.ads.sync_recovered' | 'analytics.synced' | 'message.received' | 'conversation.started' | 'conversation.control_changed' | 'call.received' | 'call.ended' | 'call.failed' | 'call.permission_request' | 'message.sent' | 'message.edited' | 'message.deleted' | 'message.delivered' | 'message.read' | 'message.played' | 'message.failed' | 'reaction.received' | 'referral.received' | 'comment.received' | 'review.new' | 'review.updated' | 'lead.received' | 'ad.status_changed' | 'ad.review.approved' | 'ad.review.rejected' | 'ad.delivery_issue' | 'campaign.budget.depleted' | 'ad_account.status_changed' | 'ad.video.processed' | 'whatsapp.template.status_updated' | 'whatsapp.template.category_updated' | 'whatsapp.account.name_status_updated' | 'whatsapp.account.quality_updated' | 'whatsapp.account.status_updated' | 'whatsapp.account.alert_received' | 'whatsapp.contact.identity_changed' | 'whatsapp.automatic_event' | 'whatsapp.number.activated' | 'whatsapp.number.declined' | 'whatsapp.number.action_required' | 'whatsapp.number.verification_required' | 'whatsapp.number.suspended' | 'whatsapp.number.reactivated' | 'whatsapp.number.released' | 'whatsapp.number.kyc_submitted' | 'phone_number.stock_available' | 'verification.approved' | 'verification.failed' | 'api.changelog.published' | 'sms.registration.action_required' | 'sms.registration.status_updated' | 'branded_calling.identity.status_updated' | 'branded_calling.identity.action_required' | 'branded_calling.number.status_updated' | 'rcs.agent.status_updated' | 'commerce.product.created' | 'commerce.product.updated' | 'commerce.product.deleted' | 'commerce.order.created' | 'commerce.order.updated' | 'commerce.order.refunded' | 'contact.tag_added' | 'contact.tag_removed' | 'contact.field_changed' | 'sequence.enrolled' | 'sequence.exited' | 'workflow.run.started' | 'workflow.run.completed' | 'workflow.run.failed' | 'support.run.completed' | 'support.run.failed')>;
|
|
13277
13277
|
/**
|
|
13278
13278
|
* Whether webhook delivery is enabled
|
|
13279
13279
|
*/
|
|
@@ -13306,6 +13306,26 @@ export type Webhook = {
|
|
|
13306
13306
|
accountIds?: Array<(string)>;
|
|
13307
13307
|
};
|
|
13308
13308
|
|
|
13309
|
+
/**
|
|
13310
|
+
* The connected ads account the event belongs to.
|
|
13311
|
+
*/
|
|
13312
|
+
export type WebhookAdsAccount = {
|
|
13313
|
+
/**
|
|
13314
|
+
* Internal Zernio account ID (same as used in /v1/accounts/{accountId}).
|
|
13315
|
+
*/
|
|
13316
|
+
accountId: string;
|
|
13317
|
+
/**
|
|
13318
|
+
* Internal Zernio profile ID this account belongs to.
|
|
13319
|
+
*/
|
|
13320
|
+
profileId: string;
|
|
13321
|
+
/**
|
|
13322
|
+
* Ads connection platform (`metaads`, `googleads`, `tiktokads`, `linkedinads`, `pinterestads`, `xads`, ...).
|
|
13323
|
+
*/
|
|
13324
|
+
platform: string;
|
|
13325
|
+
username: string;
|
|
13326
|
+
displayName?: (string) | null;
|
|
13327
|
+
};
|
|
13328
|
+
|
|
13309
13329
|
export type WebhookAdsSyncAccount = {
|
|
13310
13330
|
/**
|
|
13311
13331
|
* The ads connection's account ID (same as used in /v1/accounts/{accountId})
|
|
@@ -13706,6 +13726,126 @@ export type event5 = 'account.disconnected';
|
|
|
13706
13726
|
*/
|
|
13707
13727
|
export type disconnectionType = 'intentional' | 'unintentional';
|
|
13708
13728
|
|
|
13729
|
+
/**
|
|
13730
|
+
* Webhook payload for the `ad_account.status_changed` event. Fires when an ad
|
|
13731
|
+
* account Zernio already tracked moves between `active`, `restricted`, `disabled`
|
|
13732
|
+
* and `closed`, as read by Zernio's ad account discovery (Meta, Google, TikTok, X).
|
|
13733
|
+
* An account seen for the first time, an account not seen in the last 48 hours,
|
|
13734
|
+
* or a platform status Zernio does not recognize, never fires it.
|
|
13735
|
+
*
|
|
13736
|
+
* `restricted` means the account exists but cannot run ads normally until
|
|
13737
|
+
* something is settled (Meta unpaid balance or risk review, TikTok limits or
|
|
13738
|
+
* pending verification, X review). Each new status fires at most once per
|
|
13739
|
+
* account per 24 hours.
|
|
13740
|
+
*
|
|
13741
|
+
*/
|
|
13742
|
+
export type WebhookPayloadAdAccountStatusChanged = {
|
|
13743
|
+
/**
|
|
13744
|
+
* Stable webhook event ID: the dedupe key, also sent as the X-Zernio-Event-Id header and identical on every retry and redelivery.
|
|
13745
|
+
*/
|
|
13746
|
+
id: string;
|
|
13747
|
+
profiles?: WebhookProfiles;
|
|
13748
|
+
/**
|
|
13749
|
+
* Always true when present: only a sample sent by POST /v1/webhooks/test with an event carries it. Real deliveries never do.
|
|
13750
|
+
*/
|
|
13751
|
+
test?: boolean;
|
|
13752
|
+
event: 'ad_account.status_changed';
|
|
13753
|
+
account: WebhookAdsAccount;
|
|
13754
|
+
adAccount: {
|
|
13755
|
+
/**
|
|
13756
|
+
* Platform-native ad account ID.
|
|
13757
|
+
*/
|
|
13758
|
+
platformAdAccountId: string;
|
|
13759
|
+
name: (string) | null;
|
|
13760
|
+
};
|
|
13761
|
+
status: {
|
|
13762
|
+
previous: 'active' | 'restricted' | 'disabled' | 'closed';
|
|
13763
|
+
current: 'active' | 'restricted' | 'disabled' | 'closed';
|
|
13764
|
+
/**
|
|
13765
|
+
* Platform-native status, forwarded verbatim (Meta `account_status` code such as `2`, Google `SUSPENDED`, TikTok `STATUS_LIMIT`, X `REJECTED`).
|
|
13766
|
+
*/
|
|
13767
|
+
raw: string;
|
|
13768
|
+
};
|
|
13769
|
+
/**
|
|
13770
|
+
* UTC time at which Zernio generated this event.
|
|
13771
|
+
*/
|
|
13772
|
+
timestamp: string;
|
|
13773
|
+
};
|
|
13774
|
+
|
|
13775
|
+
export type event6 = 'ad_account.status_changed';
|
|
13776
|
+
|
|
13777
|
+
export type previous = 'active' | 'restricted' | 'disabled' | 'closed';
|
|
13778
|
+
|
|
13779
|
+
export type current = 'active' | 'restricted' | 'disabled' | 'closed';
|
|
13780
|
+
|
|
13781
|
+
/**
|
|
13782
|
+
* Webhook payload for the `ad.delivery_issue` event. Fires when an ad Zernio
|
|
13783
|
+
* already tracked moves into the platform's error state: Meta `WITH_ISSUES`
|
|
13784
|
+
* (payment, policy and account problems), TikTok account punishment or missing
|
|
13785
|
+
* balance, LinkedIn removals, and any platform status Zernio does not recognize
|
|
13786
|
+
* yet (check `issue.raw`). Ads seen for the first time by a sync never fire it.
|
|
13787
|
+
*
|
|
13788
|
+
* Detected by Zernio's own ad sync, so it arrives within one sync cycle. Each
|
|
13789
|
+
* ad fires at most once per 24 hours. On Meta, `ad.status_changed` with
|
|
13790
|
+
* `WITH_ISSUES` can also fire for the same problem, straight from Meta's webhook.
|
|
13791
|
+
*
|
|
13792
|
+
*/
|
|
13793
|
+
export type WebhookPayloadAdDeliveryIssue = {
|
|
13794
|
+
/**
|
|
13795
|
+
* Stable webhook event ID: the dedupe key, also sent as the X-Zernio-Event-Id header and identical on every retry and redelivery.
|
|
13796
|
+
*/
|
|
13797
|
+
id: string;
|
|
13798
|
+
profiles?: WebhookProfiles;
|
|
13799
|
+
/**
|
|
13800
|
+
* Always true when present: only a sample sent by POST /v1/webhooks/test with an event carries it. Real deliveries never do.
|
|
13801
|
+
*/
|
|
13802
|
+
test?: boolean;
|
|
13803
|
+
event: 'ad.delivery_issue';
|
|
13804
|
+
account: WebhookAdsAccount;
|
|
13805
|
+
adObject: {
|
|
13806
|
+
/**
|
|
13807
|
+
* Always `AD`.
|
|
13808
|
+
*/
|
|
13809
|
+
level: 'AD';
|
|
13810
|
+
/**
|
|
13811
|
+
* Platform-native ad ID.
|
|
13812
|
+
*/
|
|
13813
|
+
platformId: string;
|
|
13814
|
+
/**
|
|
13815
|
+
* Platform-native ad account ID.
|
|
13816
|
+
*/
|
|
13817
|
+
platformAdAccountId: string;
|
|
13818
|
+
/**
|
|
13819
|
+
* Zernio ad ID, usable with GET /v1/ads/{adId}.
|
|
13820
|
+
*/
|
|
13821
|
+
adId: string;
|
|
13822
|
+
name: string;
|
|
13823
|
+
};
|
|
13824
|
+
issue: {
|
|
13825
|
+
/**
|
|
13826
|
+
* Platform-native status string, forwarded verbatim (Meta `WITH_ISSUES`, TikTok `ADVERTISER_ACCOUNT_PUNISH`, LinkedIn `REMOVED`, ...).
|
|
13827
|
+
*/
|
|
13828
|
+
raw: string;
|
|
13829
|
+
/**
|
|
13830
|
+
* What the platform says is wrong. Meta reports it per campaign; other networks send no message today, so it is empty there.
|
|
13831
|
+
*/
|
|
13832
|
+
reasons: Array<{
|
|
13833
|
+
message: string;
|
|
13834
|
+
}>;
|
|
13835
|
+
};
|
|
13836
|
+
/**
|
|
13837
|
+
* UTC time at which Zernio generated this event.
|
|
13838
|
+
*/
|
|
13839
|
+
timestamp: string;
|
|
13840
|
+
};
|
|
13841
|
+
|
|
13842
|
+
export type event7 = 'ad.delivery_issue';
|
|
13843
|
+
|
|
13844
|
+
/**
|
|
13845
|
+
* Always `AD`.
|
|
13846
|
+
*/
|
|
13847
|
+
export type level2 = 'AD';
|
|
13848
|
+
|
|
13709
13849
|
/**
|
|
13710
13850
|
* Webhook payload for the `ad.review.approved` and `ad.review.rejected` events.
|
|
13711
13851
|
* Emitted for every ad network Zernio syncs (Meta, Google, TikTok, LinkedIn,
|
|
@@ -13734,25 +13874,7 @@ export type WebhookPayloadAdReview = {
|
|
|
13734
13874
|
*/
|
|
13735
13875
|
test?: boolean;
|
|
13736
13876
|
event: 'ad.review.approved' | 'ad.review.rejected';
|
|
13737
|
-
|
|
13738
|
-
* The connected ads account that owns the ad.
|
|
13739
|
-
*/
|
|
13740
|
-
account: {
|
|
13741
|
-
/**
|
|
13742
|
-
* Internal Zernio account ID (same as used in /v1/accounts/{accountId}).
|
|
13743
|
-
*/
|
|
13744
|
-
accountId: string;
|
|
13745
|
-
/**
|
|
13746
|
-
* Internal Zernio profile ID this account belongs to.
|
|
13747
|
-
*/
|
|
13748
|
-
profileId: string;
|
|
13749
|
-
/**
|
|
13750
|
-
* Ads connection platform (`metaads`, `googleads`, `tiktokads`, `linkedinads`, `pinterestads`, `xads`, ...).
|
|
13751
|
-
*/
|
|
13752
|
-
platform: string;
|
|
13753
|
-
username: string;
|
|
13754
|
-
displayName?: (string) | null;
|
|
13755
|
-
};
|
|
13877
|
+
account: WebhookAdsAccount;
|
|
13756
13878
|
adObject: {
|
|
13757
13879
|
/**
|
|
13758
13880
|
* Always `AD`.
|
|
@@ -13791,12 +13913,7 @@ export type WebhookPayloadAdReview = {
|
|
|
13791
13913
|
timestamp: string;
|
|
13792
13914
|
};
|
|
13793
13915
|
|
|
13794
|
-
export type
|
|
13795
|
-
|
|
13796
|
-
/**
|
|
13797
|
-
* Always `AD`.
|
|
13798
|
-
*/
|
|
13799
|
-
export type level2 = 'AD';
|
|
13916
|
+
export type event8 = 'ad.review.approved' | 'ad.review.rejected';
|
|
13800
13917
|
|
|
13801
13918
|
export type status38 = 'approved' | 'rejected';
|
|
13802
13919
|
|
|
@@ -13925,7 +14042,7 @@ export type WebhookPayloadAdStatusChanged = {
|
|
|
13925
14042
|
timestamp: string;
|
|
13926
14043
|
};
|
|
13927
14044
|
|
|
13928
|
-
export type
|
|
14045
|
+
export type event9 = 'ad.status_changed';
|
|
13929
14046
|
|
|
13930
14047
|
/**
|
|
13931
14048
|
* Hierarchy level the status applies to. Mirrors Meta's `level`. Creative-level events are not forwarded.
|
|
@@ -13996,7 +14113,7 @@ export type WebhookPayloadAdVideoProcessed = {
|
|
|
13996
14113
|
timestamp: string;
|
|
13997
14114
|
};
|
|
13998
14115
|
|
|
13999
|
-
export type
|
|
14116
|
+
export type event10 = 'ad.video.processed';
|
|
14000
14117
|
|
|
14001
14118
|
/**
|
|
14002
14119
|
* `ready`: usable as `video.id` on the create endpoints. `error`: Meta could not process it; upload again.
|
|
@@ -14079,7 +14196,7 @@ export type WebhookPayloadAnalyticsSynced = {
|
|
|
14079
14196
|
timestamp: string;
|
|
14080
14197
|
};
|
|
14081
14198
|
|
|
14082
|
-
export type
|
|
14199
|
+
export type event11 = 'analytics.synced';
|
|
14083
14200
|
|
|
14084
14201
|
export type WebhookPayloadApiChangelogPublished = {
|
|
14085
14202
|
/**
|
|
@@ -14098,7 +14215,7 @@ export type WebhookPayloadApiChangelogPublished = {
|
|
|
14098
14215
|
timestamp: string;
|
|
14099
14216
|
};
|
|
14100
14217
|
|
|
14101
|
-
export type
|
|
14218
|
+
export type event12 = 'api.changelog.published';
|
|
14102
14219
|
|
|
14103
14220
|
/**
|
|
14104
14221
|
* Webhook payload for the `call.ended` event. Fires on call hangup
|
|
@@ -14173,7 +14290,7 @@ export type WebhookPayloadCallEnded = {
|
|
|
14173
14290
|
timestamp: string;
|
|
14174
14291
|
};
|
|
14175
14292
|
|
|
14176
|
-
export type
|
|
14293
|
+
export type event13 = 'call.ended';
|
|
14177
14294
|
|
|
14178
14295
|
/**
|
|
14179
14296
|
* Webhook payload for the `call.failed` event. Fired when a call
|
|
@@ -14212,7 +14329,7 @@ export type WebhookPayloadCallFailed = {
|
|
|
14212
14329
|
timestamp: string;
|
|
14213
14330
|
};
|
|
14214
14331
|
|
|
14215
|
-
export type
|
|
14332
|
+
export type event14 = 'call.failed';
|
|
14216
14333
|
|
|
14217
14334
|
/**
|
|
14218
14335
|
* Webhook payload for the `call.permission_request` event. Fires
|
|
@@ -14254,7 +14371,7 @@ export type WebhookPayloadCallPermissionRequest = {
|
|
|
14254
14371
|
timestamp: string;
|
|
14255
14372
|
};
|
|
14256
14373
|
|
|
14257
|
-
export type
|
|
14374
|
+
export type event15 = 'call.permission_request';
|
|
14258
14375
|
|
|
14259
14376
|
export type response = 'accept' | 'reject';
|
|
14260
14377
|
|
|
@@ -14313,7 +14430,63 @@ export type WebhookPayloadCallReceived = {
|
|
|
14313
14430
|
timestamp: string;
|
|
14314
14431
|
};
|
|
14315
14432
|
|
|
14316
|
-
export type
|
|
14433
|
+
export type event16 = 'call.received';
|
|
14434
|
+
|
|
14435
|
+
/**
|
|
14436
|
+
* Webhook payload for the `campaign.budget.depleted` event. Fires when a campaign
|
|
14437
|
+
* Zernio already tracked stops delivering because its budget ran out. TikTok only:
|
|
14438
|
+
* it is the one network that reports an exhausted budget on the ad. Meta and Google
|
|
14439
|
+
* keep such ads `ACTIVE`, so they never fire it.
|
|
14440
|
+
*
|
|
14441
|
+
* Detected by Zernio's own ad sync. Each campaign fires at most once per 6 hours, so a
|
|
14442
|
+
* daily budget that runs out again the next day is announced again.
|
|
14443
|
+
*
|
|
14444
|
+
*/
|
|
14445
|
+
export type WebhookPayloadCampaignBudgetDepleted = {
|
|
14446
|
+
/**
|
|
14447
|
+
* Stable webhook event ID: the dedupe key, also sent as the X-Zernio-Event-Id header and identical on every retry and redelivery.
|
|
14448
|
+
*/
|
|
14449
|
+
id: string;
|
|
14450
|
+
profiles?: WebhookProfiles;
|
|
14451
|
+
/**
|
|
14452
|
+
* Always true when present: only a sample sent by POST /v1/webhooks/test with an event carries it. Real deliveries never do.
|
|
14453
|
+
*/
|
|
14454
|
+
test?: boolean;
|
|
14455
|
+
event: 'campaign.budget.depleted';
|
|
14456
|
+
account: WebhookAdsAccount;
|
|
14457
|
+
adObject: {
|
|
14458
|
+
/**
|
|
14459
|
+
* Always `CAMPAIGN`.
|
|
14460
|
+
*/
|
|
14461
|
+
level: 'CAMPAIGN';
|
|
14462
|
+
/**
|
|
14463
|
+
* Platform-native campaign ID.
|
|
14464
|
+
*/
|
|
14465
|
+
platformId: string;
|
|
14466
|
+
/**
|
|
14467
|
+
* Platform-native ad account ID.
|
|
14468
|
+
*/
|
|
14469
|
+
platformAdAccountId: string;
|
|
14470
|
+
name: (string) | null;
|
|
14471
|
+
};
|
|
14472
|
+
budget: {
|
|
14473
|
+
/**
|
|
14474
|
+
* Platform-native status string, forwarded verbatim (TikTok `AD_STATUS_CAMPAIGN_EXCEED`).
|
|
14475
|
+
*/
|
|
14476
|
+
raw: string;
|
|
14477
|
+
};
|
|
14478
|
+
/**
|
|
14479
|
+
* UTC time at which Zernio generated this event.
|
|
14480
|
+
*/
|
|
14481
|
+
timestamp: string;
|
|
14482
|
+
};
|
|
14483
|
+
|
|
14484
|
+
export type event17 = 'campaign.budget.depleted';
|
|
14485
|
+
|
|
14486
|
+
/**
|
|
14487
|
+
* Always `CAMPAIGN`.
|
|
14488
|
+
*/
|
|
14489
|
+
export type level4 = 'CAMPAIGN';
|
|
14317
14490
|
|
|
14318
14491
|
/**
|
|
14319
14492
|
* Webhook payload for comment received events (Instagram, Facebook, Threads, YouTube, LinkedIn, Bluesky, Reddit, TikTok). X/Twitter does NOT fire this event. TikTok events carry only the author id: the comment.update webhook has no username, picture or owner flag.
|
|
@@ -14490,7 +14663,7 @@ export type WebhookPayloadComment = {
|
|
|
14490
14663
|
timestamp: string;
|
|
14491
14664
|
};
|
|
14492
14665
|
|
|
14493
|
-
export type
|
|
14666
|
+
export type event18 = 'comment.received';
|
|
14494
14667
|
|
|
14495
14668
|
export type platform15 = 'instagram' | 'facebook' | 'threads' | 'youtube' | 'linkedin' | 'bluesky' | 'reddit' | 'tiktok';
|
|
14496
14669
|
|
|
@@ -14536,7 +14709,7 @@ export type WebhookPayloadCommerceOrder = {
|
|
|
14536
14709
|
};
|
|
14537
14710
|
};
|
|
14538
14711
|
|
|
14539
|
-
export type
|
|
14712
|
+
export type event19 = 'commerce.order.created' | 'commerce.order.updated' | 'commerce.order.refunded';
|
|
14540
14713
|
|
|
14541
14714
|
export type type17 = 'order';
|
|
14542
14715
|
|
|
@@ -14579,7 +14752,7 @@ export type WebhookPayloadCommerceProduct = {
|
|
|
14579
14752
|
};
|
|
14580
14753
|
};
|
|
14581
14754
|
|
|
14582
|
-
export type
|
|
14755
|
+
export type event20 = 'commerce.product.created' | 'commerce.product.updated' | 'commerce.product.deleted';
|
|
14583
14756
|
|
|
14584
14757
|
export type type18 = 'product';
|
|
14585
14758
|
|
|
@@ -14619,7 +14792,7 @@ export type WebhookPayloadContactFieldChanged = {
|
|
|
14619
14792
|
source: 'api' | 'workflow' | 'automation';
|
|
14620
14793
|
};
|
|
14621
14794
|
|
|
14622
|
-
export type
|
|
14795
|
+
export type event21 = 'contact.field_changed';
|
|
14623
14796
|
|
|
14624
14797
|
/**
|
|
14625
14798
|
* Who wrote the field: the API or dashboard, a workflow set_field node, or an automation.
|
|
@@ -14651,7 +14824,7 @@ export type WebhookPayloadContactTag = {
|
|
|
14651
14824
|
source: 'api' | 'workflow' | 'automation';
|
|
14652
14825
|
};
|
|
14653
14826
|
|
|
14654
|
-
export type
|
|
14827
|
+
export type event22 = 'contact.tag_added' | 'contact.tag_removed';
|
|
14655
14828
|
|
|
14656
14829
|
/**
|
|
14657
14830
|
* Who answers a conversation changed under Meta's handover protocol. WhatsApp: Meta
|
|
@@ -14697,7 +14870,7 @@ export type WebhookPayloadConversationControlChanged = {
|
|
|
14697
14870
|
timestamp: string;
|
|
14698
14871
|
};
|
|
14699
14872
|
|
|
14700
|
-
export type
|
|
14873
|
+
export type event23 = 'conversation.control_changed';
|
|
14701
14874
|
|
|
14702
14875
|
/**
|
|
14703
14876
|
* Who answers now. ai_agent: Meta Business Agent (WhatsApp); app: you; other: another app (a WhatsApp partner, or a Messenger / Instagram receiver such as Page Inbox).
|
|
@@ -14739,7 +14912,7 @@ export type WebhookPayloadConversationStarted = {
|
|
|
14739
14912
|
timestamp: string;
|
|
14740
14913
|
};
|
|
14741
14914
|
|
|
14742
|
-
export type
|
|
14915
|
+
export type event24 = 'conversation.started';
|
|
14743
14916
|
|
|
14744
14917
|
/**
|
|
14745
14918
|
* Webhook payload for post.external.created / post.external.updated /
|
|
@@ -14776,7 +14949,7 @@ export type WebhookPayloadExternalPost = {
|
|
|
14776
14949
|
timestamp: string;
|
|
14777
14950
|
};
|
|
14778
14951
|
|
|
14779
|
-
export type
|
|
14952
|
+
export type event25 = 'post.external.created' | 'post.external.updated' | 'post.external.deleted';
|
|
14780
14953
|
|
|
14781
14954
|
/**
|
|
14782
14955
|
* Webhook payload for lead.received events (Meta Lead Gen / Instant Forms).
|
|
@@ -14852,7 +15025,7 @@ export type WebhookPayloadLead = {
|
|
|
14852
15025
|
timestamp: string;
|
|
14853
15026
|
};
|
|
14854
15027
|
|
|
14855
|
-
export type
|
|
15028
|
+
export type event26 = 'lead.received';
|
|
14856
15029
|
|
|
14857
15030
|
export type platform16 = 'facebook';
|
|
14858
15031
|
|
|
@@ -15443,7 +15616,7 @@ export type WebhookPayloadMessage = {
|
|
|
15443
15616
|
timestamp: string;
|
|
15444
15617
|
};
|
|
15445
15618
|
|
|
15446
|
-
export type
|
|
15619
|
+
export type event27 = 'message.received';
|
|
15447
15620
|
|
|
15448
15621
|
/**
|
|
15449
15622
|
* Which Zernio surface produced the message. Always present and
|
|
@@ -15509,7 +15682,7 @@ export type WebhookPayloadMessageDeleted = {
|
|
|
15509
15682
|
timestamp: string;
|
|
15510
15683
|
};
|
|
15511
15684
|
|
|
15512
|
-
export type
|
|
15685
|
+
export type event28 = 'message.deleted';
|
|
15513
15686
|
|
|
15514
15687
|
/**
|
|
15515
15688
|
* Shared payload for message.delivered, message.read, message.played and
|
|
@@ -15577,7 +15750,7 @@ export type WebhookPayloadMessageDeliveryStatus = {
|
|
|
15577
15750
|
timestamp: string;
|
|
15578
15751
|
};
|
|
15579
15752
|
|
|
15580
|
-
export type
|
|
15753
|
+
export type event29 = 'message.delivered' | 'message.read' | 'message.played' | 'message.failed';
|
|
15581
15754
|
|
|
15582
15755
|
/**
|
|
15583
15756
|
* Webhook payload for message.edited events. Fires when the sender
|
|
@@ -15620,7 +15793,7 @@ export type WebhookPayloadMessageEdited = {
|
|
|
15620
15793
|
timestamp: string;
|
|
15621
15794
|
};
|
|
15622
15795
|
|
|
15623
|
-
export type
|
|
15796
|
+
export type event30 = 'message.edited';
|
|
15624
15797
|
|
|
15625
15798
|
/**
|
|
15626
15799
|
* Webhook payload for message sent events (fired when a message is sent via the API, or from the WhatsApp Business app on Coexistence numbers)
|
|
@@ -15866,7 +16039,7 @@ export type WebhookPayloadMessageSent = {
|
|
|
15866
16039
|
timestamp: string;
|
|
15867
16040
|
};
|
|
15868
16041
|
|
|
15869
|
-
export type
|
|
16042
|
+
export type event31 = 'message.sent';
|
|
15870
16043
|
|
|
15871
16044
|
/**
|
|
15872
16045
|
* Every platform whose outgoing messages Zernio observes. sms is absent on purpose: its carrier receipts update delivery status and never raise message.sent.
|
|
@@ -15924,7 +16097,7 @@ export type WebhookPayloadPhoneNumberStockAvailable = {
|
|
|
15924
16097
|
timestamp: string;
|
|
15925
16098
|
};
|
|
15926
16099
|
|
|
15927
|
-
export type
|
|
16100
|
+
export type event32 = 'phone_number.stock_available';
|
|
15928
16101
|
|
|
15929
16102
|
/**
|
|
15930
16103
|
* Webhook payload for post events
|
|
@@ -15979,7 +16152,7 @@ export type WebhookPayloadPost = {
|
|
|
15979
16152
|
timestamp: string;
|
|
15980
16153
|
};
|
|
15981
16154
|
|
|
15982
|
-
export type
|
|
16155
|
+
export type event33 = 'post.scheduled' | 'post.published' | 'post.failed' | 'post.partial' | 'post.cancelled' | 'post.recycled';
|
|
15983
16156
|
|
|
15984
16157
|
/**
|
|
15985
16158
|
* Webhook payload for the per-platform terminal events
|
|
@@ -16103,7 +16276,7 @@ export type WebhookPayloadPostPlatform = {
|
|
|
16103
16276
|
timestamp: string;
|
|
16104
16277
|
};
|
|
16105
16278
|
|
|
16106
|
-
export type
|
|
16279
|
+
export type event34 = 'post.platform.published' | 'post.platform.failed' | 'post.platform.deleted' | 'post.tiktok.url_resolved';
|
|
16107
16280
|
|
|
16108
16281
|
/**
|
|
16109
16282
|
* Terminal status this event fires on. Matches the event suffix.
|
|
@@ -16168,7 +16341,7 @@ export type WebhookPayloadReaction = {
|
|
|
16168
16341
|
timestamp: string;
|
|
16169
16342
|
};
|
|
16170
16343
|
|
|
16171
|
-
export type
|
|
16344
|
+
export type event35 = 'reaction.received';
|
|
16172
16345
|
|
|
16173
16346
|
export type action = 'added' | 'removed';
|
|
16174
16347
|
|
|
@@ -16247,7 +16420,7 @@ export type WebhookPayloadReferral = {
|
|
|
16247
16420
|
timestamp: string;
|
|
16248
16421
|
};
|
|
16249
16422
|
|
|
16250
|
-
export type
|
|
16423
|
+
export type event36 = 'referral.received';
|
|
16251
16424
|
|
|
16252
16425
|
/**
|
|
16253
16426
|
* Webhook payload for the review.new event (new review posted on a connected account).
|
|
@@ -16279,7 +16452,7 @@ export type WebhookPayloadReviewNew = {
|
|
|
16279
16452
|
timestamp: string;
|
|
16280
16453
|
};
|
|
16281
16454
|
|
|
16282
|
-
export type
|
|
16455
|
+
export type event37 = 'review.new';
|
|
16283
16456
|
|
|
16284
16457
|
/**
|
|
16285
16458
|
* Webhook payload for the review.updated event. Fired when the reviewer edits their
|
|
@@ -16317,7 +16490,7 @@ export type WebhookPayloadReviewUpdated = {
|
|
|
16317
16490
|
timestamp: string;
|
|
16318
16491
|
};
|
|
16319
16492
|
|
|
16320
|
-
export type
|
|
16493
|
+
export type event38 = 'review.updated';
|
|
16321
16494
|
|
|
16322
16495
|
export type WebhookPayloadSequenceEnrollment = {
|
|
16323
16496
|
/**
|
|
@@ -16350,7 +16523,7 @@ export type WebhookPayloadSequenceEnrollment = {
|
|
|
16350
16523
|
exitReason?: 'completed' | 'replied' | 'manual' | 'failed' | 'unsubscribed';
|
|
16351
16524
|
};
|
|
16352
16525
|
|
|
16353
|
-
export type
|
|
16526
|
+
export type event39 = 'sequence.enrolled' | 'sequence.exited';
|
|
16354
16527
|
|
|
16355
16528
|
/**
|
|
16356
16529
|
* sequence.exited only. completed: the last step was sent; replied: the contact replied and the sequence exits on reply; manual: unenrolled through the API; failed: the step kept failing to send; unsubscribed: the contact opted out.
|
|
@@ -16371,7 +16544,7 @@ export type WebhookPayloadSupportRun = {
|
|
|
16371
16544
|
run: SupportRun;
|
|
16372
16545
|
};
|
|
16373
16546
|
|
|
16374
|
-
export type
|
|
16547
|
+
export type event40 = 'support.run.completed' | 'support.run.failed';
|
|
16375
16548
|
|
|
16376
16549
|
/**
|
|
16377
16550
|
* Webhook payload for test deliveries
|
|
@@ -16392,7 +16565,7 @@ export type WebhookPayloadTest = {
|
|
|
16392
16565
|
timestamp: string;
|
|
16393
16566
|
};
|
|
16394
16567
|
|
|
16395
|
-
export type
|
|
16568
|
+
export type event41 = 'webhook.test';
|
|
16396
16569
|
|
|
16397
16570
|
/**
|
|
16398
16571
|
* Webhook payload for `whatsapp.account.alert_received`, forwarded from Meta's
|
|
@@ -16444,7 +16617,7 @@ export type WebhookPayloadWhatsAppAccountAlertReceived = {
|
|
|
16444
16617
|
timestamp: string;
|
|
16445
16618
|
};
|
|
16446
16619
|
|
|
16447
|
-
export type
|
|
16620
|
+
export type event42 = 'whatsapp.account.alert_received';
|
|
16448
16621
|
|
|
16449
16622
|
export type platform18 = 'whatsapp';
|
|
16450
16623
|
|
|
@@ -16500,7 +16673,7 @@ export type WebhookPayloadWhatsAppAccountNameStatusUpdated = {
|
|
|
16500
16673
|
timestamp: string;
|
|
16501
16674
|
};
|
|
16502
16675
|
|
|
16503
|
-
export type
|
|
16676
|
+
export type event43 = 'whatsapp.account.name_status_updated';
|
|
16504
16677
|
|
|
16505
16678
|
/**
|
|
16506
16679
|
* Normalized from Meta's `decision` (REJECTED -> DECLINED, DEFERRED -> PENDING_REVIEW; the review is still open on DEFERRED, not a rejection).
|
|
@@ -16558,7 +16731,7 @@ export type WebhookPayloadWhatsAppAccountQualityUpdated = {
|
|
|
16558
16731
|
timestamp: string;
|
|
16559
16732
|
};
|
|
16560
16733
|
|
|
16561
|
-
export type
|
|
16734
|
+
export type event44 = 'whatsapp.account.quality_updated';
|
|
16562
16735
|
|
|
16563
16736
|
/**
|
|
16564
16737
|
* The Meta webhook field that reported the change.
|
|
@@ -16634,7 +16807,7 @@ export type WebhookPayloadWhatsAppAccountStatusUpdated = {
|
|
|
16634
16807
|
timestamp: string;
|
|
16635
16808
|
};
|
|
16636
16809
|
|
|
16637
|
-
export type
|
|
16810
|
+
export type event45 = 'whatsapp.account.status_updated';
|
|
16638
16811
|
|
|
16639
16812
|
/**
|
|
16640
16813
|
* `active` only on a reinstatement (DISABLED_UPDATE with ban state REINSTATE).
|
|
@@ -16691,7 +16864,7 @@ export type WebhookPayloadWhatsAppContactIdentityChanged = {
|
|
|
16691
16864
|
timestamp: string;
|
|
16692
16865
|
};
|
|
16693
16866
|
|
|
16694
|
-
export type
|
|
16867
|
+
export type event46 = 'whatsapp.contact.identity_changed';
|
|
16695
16868
|
|
|
16696
16869
|
/**
|
|
16697
16870
|
* Which Meta signal reported the change. `user_changed_number`: new phone number. `user_changed_user_id` and `user_id_update`: new BSUID.
|
|
@@ -16765,7 +16938,7 @@ export type WebhookPayloadWhatsAppTemplateCategoryUpdated = {
|
|
|
16765
16938
|
timestamp: string;
|
|
16766
16939
|
};
|
|
16767
16940
|
|
|
16768
|
-
export type
|
|
16941
|
+
export type event47 = 'whatsapp.template.category_updated';
|
|
16769
16942
|
|
|
16770
16943
|
/**
|
|
16771
16944
|
* `scheduled` is Meta's 24h advance notice of an upcoming
|
|
@@ -16847,7 +17020,7 @@ export type WebhookPayloadWhatsAppTemplateStatusUpdated = {
|
|
|
16847
17020
|
timestamp: string;
|
|
16848
17021
|
};
|
|
16849
17022
|
|
|
16850
|
-
export type
|
|
17023
|
+
export type event48 = 'whatsapp.template.status_updated';
|
|
16851
17024
|
|
|
16852
17025
|
/**
|
|
16853
17026
|
* New status. Forwarded verbatim from Meta's `event` field.
|
|
@@ -16914,7 +17087,7 @@ export type WebhookPayloadWorkflowRun = {
|
|
|
16914
17087
|
error?: string;
|
|
16915
17088
|
};
|
|
16916
17089
|
|
|
16917
|
-
export type
|
|
17090
|
+
export type event49 = 'workflow.run.started' | 'workflow.run.completed' | 'workflow.run.failed';
|
|
16918
17091
|
|
|
16919
17092
|
/**
|
|
16920
17093
|
* running on workflow.run.started; completed or exited (ended on purpose before the last node, e.g. a handoff) on workflow.run.completed; failed on workflow.run.failed.
|
|
@@ -28657,7 +28830,7 @@ export type CreateWebhookSettingsData = {
|
|
|
28657
28830
|
/**
|
|
28658
28831
|
* Events to subscribe to (at least one required)
|
|
28659
28832
|
*/
|
|
28660
|
-
events: Array<('post.scheduled' | 'post.published' | 'post.failed' | 'post.partial' | 'post.cancelled' | 'post.recycled' | 'post.platform.published' | 'post.platform.failed' | 'post.platform.deleted' | 'post.tiktok.url_resolved' | 'post.external.created' | 'post.external.updated' | 'post.external.deleted' | 'account.connected' | 'account.disconnected' | 'account.ads.initial_sync_completed' | 'account.ads.sync_failed' | 'account.ads.sync_recovered' | 'analytics.synced' | 'message.received' | 'conversation.started' | 'conversation.control_changed' | 'call.received' | 'call.ended' | 'call.failed' | 'call.permission_request' | 'message.sent' | 'message.edited' | 'message.deleted' | 'message.delivered' | 'message.read' | 'message.played' | 'message.failed' | 'reaction.received' | 'referral.received' | 'comment.received' | 'review.new' | 'review.updated' | 'lead.received' | 'ad.status_changed' | 'ad.review.approved' | 'ad.review.rejected' | 'ad.video.processed' | 'whatsapp.template.status_updated' | 'whatsapp.template.category_updated' | 'whatsapp.account.name_status_updated' | 'whatsapp.account.quality_updated' | 'whatsapp.account.status_updated' | 'whatsapp.account.alert_received' | 'whatsapp.contact.identity_changed' | 'whatsapp.automatic_event' | 'whatsapp.number.activated' | 'whatsapp.number.declined' | 'whatsapp.number.action_required' | 'whatsapp.number.verification_required' | 'whatsapp.number.suspended' | 'whatsapp.number.reactivated' | 'whatsapp.number.released' | 'whatsapp.number.kyc_submitted' | 'phone_number.stock_available' | 'verification.approved' | 'verification.failed' | 'api.changelog.published' | 'sms.registration.action_required' | 'sms.registration.status_updated' | 'branded_calling.identity.status_updated' | 'branded_calling.identity.action_required' | 'branded_calling.number.status_updated' | 'rcs.agent.status_updated' | 'commerce.product.created' | 'commerce.product.updated' | 'commerce.product.deleted' | 'commerce.order.created' | 'commerce.order.updated' | 'commerce.order.refunded' | 'contact.tag_added' | 'contact.tag_removed' | 'contact.field_changed' | 'sequence.enrolled' | 'sequence.exited' | 'workflow.run.started' | 'workflow.run.completed' | 'workflow.run.failed' | 'support.run.completed' | 'support.run.failed')>;
|
|
28833
|
+
events: Array<('post.scheduled' | 'post.published' | 'post.failed' | 'post.partial' | 'post.cancelled' | 'post.recycled' | 'post.platform.published' | 'post.platform.failed' | 'post.platform.deleted' | 'post.tiktok.url_resolved' | 'post.external.created' | 'post.external.updated' | 'post.external.deleted' | 'account.connected' | 'account.disconnected' | 'account.ads.initial_sync_completed' | 'account.ads.sync_failed' | 'account.ads.sync_recovered' | 'analytics.synced' | 'message.received' | 'conversation.started' | 'conversation.control_changed' | 'call.received' | 'call.ended' | 'call.failed' | 'call.permission_request' | 'message.sent' | 'message.edited' | 'message.deleted' | 'message.delivered' | 'message.read' | 'message.played' | 'message.failed' | 'reaction.received' | 'referral.received' | 'comment.received' | 'review.new' | 'review.updated' | 'lead.received' | 'ad.status_changed' | 'ad.review.approved' | 'ad.review.rejected' | 'ad.delivery_issue' | 'campaign.budget.depleted' | 'ad_account.status_changed' | 'ad.video.processed' | 'whatsapp.template.status_updated' | 'whatsapp.template.category_updated' | 'whatsapp.account.name_status_updated' | 'whatsapp.account.quality_updated' | 'whatsapp.account.status_updated' | 'whatsapp.account.alert_received' | 'whatsapp.contact.identity_changed' | 'whatsapp.automatic_event' | 'whatsapp.number.activated' | 'whatsapp.number.declined' | 'whatsapp.number.action_required' | 'whatsapp.number.verification_required' | 'whatsapp.number.suspended' | 'whatsapp.number.reactivated' | 'whatsapp.number.released' | 'whatsapp.number.kyc_submitted' | 'phone_number.stock_available' | 'verification.approved' | 'verification.failed' | 'api.changelog.published' | 'sms.registration.action_required' | 'sms.registration.status_updated' | 'branded_calling.identity.status_updated' | 'branded_calling.identity.action_required' | 'branded_calling.number.status_updated' | 'rcs.agent.status_updated' | 'commerce.product.created' | 'commerce.product.updated' | 'commerce.product.deleted' | 'commerce.order.created' | 'commerce.order.updated' | 'commerce.order.refunded' | 'contact.tag_added' | 'contact.tag_removed' | 'contact.field_changed' | 'sequence.enrolled' | 'sequence.exited' | 'workflow.run.started' | 'workflow.run.completed' | 'workflow.run.failed' | 'support.run.completed' | 'support.run.failed')>;
|
|
28661
28834
|
/**
|
|
28662
28835
|
* Enable or disable webhook delivery. Defaults to `true` when omitted.
|
|
28663
28836
|
*/
|
|
@@ -28723,7 +28896,7 @@ export type UpdateWebhookSettingsData = {
|
|
|
28723
28896
|
/**
|
|
28724
28897
|
* Events to subscribe to. Must contain at least one event if provided.
|
|
28725
28898
|
*/
|
|
28726
|
-
events?: Array<('post.scheduled' | 'post.published' | 'post.failed' | 'post.partial' | 'post.cancelled' | 'post.recycled' | 'post.platform.published' | 'post.platform.failed' | 'post.platform.deleted' | 'post.tiktok.url_resolved' | 'post.external.created' | 'post.external.updated' | 'post.external.deleted' | 'account.connected' | 'account.disconnected' | 'account.ads.initial_sync_completed' | 'account.ads.sync_failed' | 'account.ads.sync_recovered' | 'analytics.synced' | 'message.received' | 'conversation.started' | 'conversation.control_changed' | 'call.received' | 'call.ended' | 'call.failed' | 'call.permission_request' | 'message.sent' | 'message.edited' | 'message.deleted' | 'message.delivered' | 'message.read' | 'message.played' | 'message.failed' | 'reaction.received' | 'referral.received' | 'comment.received' | 'review.new' | 'review.updated' | 'lead.received' | 'ad.status_changed' | 'ad.review.approved' | 'ad.review.rejected' | 'ad.video.processed' | 'whatsapp.template.status_updated' | 'whatsapp.template.category_updated' | 'whatsapp.account.name_status_updated' | 'whatsapp.account.quality_updated' | 'whatsapp.account.status_updated' | 'whatsapp.account.alert_received' | 'whatsapp.contact.identity_changed' | 'whatsapp.automatic_event' | 'whatsapp.number.activated' | 'whatsapp.number.declined' | 'whatsapp.number.action_required' | 'whatsapp.number.verification_required' | 'whatsapp.number.suspended' | 'whatsapp.number.reactivated' | 'whatsapp.number.released' | 'whatsapp.number.kyc_submitted' | 'phone_number.stock_available' | 'verification.approved' | 'verification.failed' | 'api.changelog.published' | 'sms.registration.action_required' | 'sms.registration.status_updated' | 'branded_calling.identity.status_updated' | 'branded_calling.identity.action_required' | 'branded_calling.number.status_updated' | 'rcs.agent.status_updated' | 'commerce.product.created' | 'commerce.product.updated' | 'commerce.product.deleted' | 'commerce.order.created' | 'commerce.order.updated' | 'commerce.order.refunded' | 'contact.tag_added' | 'contact.tag_removed' | 'contact.field_changed' | 'sequence.enrolled' | 'sequence.exited' | 'workflow.run.started' | 'workflow.run.completed' | 'workflow.run.failed' | 'support.run.completed' | 'support.run.failed')>;
|
|
28899
|
+
events?: Array<('post.scheduled' | 'post.published' | 'post.failed' | 'post.partial' | 'post.cancelled' | 'post.recycled' | 'post.platform.published' | 'post.platform.failed' | 'post.platform.deleted' | 'post.tiktok.url_resolved' | 'post.external.created' | 'post.external.updated' | 'post.external.deleted' | 'account.connected' | 'account.disconnected' | 'account.ads.initial_sync_completed' | 'account.ads.sync_failed' | 'account.ads.sync_recovered' | 'analytics.synced' | 'message.received' | 'conversation.started' | 'conversation.control_changed' | 'call.received' | 'call.ended' | 'call.failed' | 'call.permission_request' | 'message.sent' | 'message.edited' | 'message.deleted' | 'message.delivered' | 'message.read' | 'message.played' | 'message.failed' | 'reaction.received' | 'referral.received' | 'comment.received' | 'review.new' | 'review.updated' | 'lead.received' | 'ad.status_changed' | 'ad.review.approved' | 'ad.review.rejected' | 'ad.delivery_issue' | 'campaign.budget.depleted' | 'ad_account.status_changed' | 'ad.video.processed' | 'whatsapp.template.status_updated' | 'whatsapp.template.category_updated' | 'whatsapp.account.name_status_updated' | 'whatsapp.account.quality_updated' | 'whatsapp.account.status_updated' | 'whatsapp.account.alert_received' | 'whatsapp.contact.identity_changed' | 'whatsapp.automatic_event' | 'whatsapp.number.activated' | 'whatsapp.number.declined' | 'whatsapp.number.action_required' | 'whatsapp.number.verification_required' | 'whatsapp.number.suspended' | 'whatsapp.number.reactivated' | 'whatsapp.number.released' | 'whatsapp.number.kyc_submitted' | 'phone_number.stock_available' | 'verification.approved' | 'verification.failed' | 'api.changelog.published' | 'sms.registration.action_required' | 'sms.registration.status_updated' | 'branded_calling.identity.status_updated' | 'branded_calling.identity.action_required' | 'branded_calling.number.status_updated' | 'rcs.agent.status_updated' | 'commerce.product.created' | 'commerce.product.updated' | 'commerce.product.deleted' | 'commerce.order.created' | 'commerce.order.updated' | 'commerce.order.refunded' | 'contact.tag_added' | 'contact.tag_removed' | 'contact.field_changed' | 'sequence.enrolled' | 'sequence.exited' | 'workflow.run.started' | 'workflow.run.completed' | 'workflow.run.failed' | 'support.run.completed' | 'support.run.failed')>;
|
|
28727
28900
|
/**
|
|
28728
28901
|
* Enable or disable webhook delivery
|
|
28729
28902
|
*/
|
|
@@ -28893,7 +29066,7 @@ export type TestWebhookData = {
|
|
|
28893
29066
|
/**
|
|
28894
29067
|
* Send a sample payload of this event instead of `webhook.test`. The sample is marked with `test: true`.
|
|
28895
29068
|
*/
|
|
28896
|
-
event?: 'post.scheduled' | 'post.published' | 'post.failed' | 'post.partial' | 'post.cancelled' | 'post.recycled' | 'post.platform.published' | 'post.platform.failed' | 'post.platform.deleted' | 'post.tiktok.url_resolved' | 'post.external.created' | 'post.external.updated' | 'post.external.deleted' | 'account.connected' | 'account.disconnected' | 'account.ads.initial_sync_completed' | 'account.ads.sync_failed' | 'account.ads.sync_recovered' | 'analytics.synced' | 'message.received' | 'message.sent' | 'message.edited' | 'message.deleted' | 'message.delivered' | 'message.read' | 'message.played' | 'message.failed' | 'reaction.received' | 'referral.received' | 'conversation.started' | 'conversation.control_changed' | 'contact.tag_added' | 'contact.tag_removed' | 'contact.field_changed' | 'sequence.enrolled' | 'sequence.exited' | 'workflow.run.started' | 'workflow.run.completed' | 'workflow.run.failed' | 'support.run.completed' | 'support.run.failed' | 'call.received' | 'call.ended' | 'call.failed' | 'call.permission_request' | 'comment.received' | 'review.new' | 'review.updated' | 'ad.status_changed' | 'ad.review.approved' | 'ad.review.rejected' | 'ad.video.processed' | 'lead.received' | 'whatsapp.template.status_updated' | 'whatsapp.template.category_updated' | 'whatsapp.account.name_status_updated' | 'whatsapp.account.quality_updated' | 'whatsapp.account.status_updated' | 'whatsapp.account.alert_received' | 'whatsapp.contact.identity_changed' | 'whatsapp.number.activated' | 'whatsapp.number.declined' | 'whatsapp.number.action_required' | 'whatsapp.automatic_event' | 'whatsapp.number.verification_required' | 'whatsapp.number.suspended' | 'whatsapp.number.reactivated' | 'whatsapp.number.released' | 'whatsapp.number.kyc_submitted' | 'phone_number.stock_available' | 'sms.registration.action_required' | 'sms.registration.status_updated' | 'branded_calling.identity.status_updated' | 'branded_calling.identity.action_required' | 'branded_calling.number.status_updated' | 'rcs.agent.status_updated' | 'verification.approved' | 'verification.failed' | 'commerce.product.created' | 'commerce.product.updated' | 'commerce.product.deleted' | 'commerce.order.created' | 'commerce.order.updated' | 'commerce.order.refunded' | 'api.changelog.published';
|
|
29069
|
+
event?: 'post.scheduled' | 'post.published' | 'post.failed' | 'post.partial' | 'post.cancelled' | 'post.recycled' | 'post.platform.published' | 'post.platform.failed' | 'post.platform.deleted' | 'post.tiktok.url_resolved' | 'post.external.created' | 'post.external.updated' | 'post.external.deleted' | 'account.connected' | 'account.disconnected' | 'account.ads.initial_sync_completed' | 'account.ads.sync_failed' | 'account.ads.sync_recovered' | 'analytics.synced' | 'message.received' | 'message.sent' | 'message.edited' | 'message.deleted' | 'message.delivered' | 'message.read' | 'message.played' | 'message.failed' | 'reaction.received' | 'referral.received' | 'conversation.started' | 'conversation.control_changed' | 'contact.tag_added' | 'contact.tag_removed' | 'contact.field_changed' | 'sequence.enrolled' | 'sequence.exited' | 'workflow.run.started' | 'workflow.run.completed' | 'workflow.run.failed' | 'support.run.completed' | 'support.run.failed' | 'call.received' | 'call.ended' | 'call.failed' | 'call.permission_request' | 'comment.received' | 'review.new' | 'review.updated' | 'ad.status_changed' | 'ad.review.approved' | 'ad.review.rejected' | 'ad.delivery_issue' | 'campaign.budget.depleted' | 'ad_account.status_changed' | 'ad.video.processed' | 'lead.received' | 'whatsapp.template.status_updated' | 'whatsapp.template.category_updated' | 'whatsapp.account.name_status_updated' | 'whatsapp.account.quality_updated' | 'whatsapp.account.status_updated' | 'whatsapp.account.alert_received' | 'whatsapp.contact.identity_changed' | 'whatsapp.number.activated' | 'whatsapp.number.declined' | 'whatsapp.number.action_required' | 'whatsapp.automatic_event' | 'whatsapp.number.verification_required' | 'whatsapp.number.suspended' | 'whatsapp.number.reactivated' | 'whatsapp.number.released' | 'whatsapp.number.kyc_submitted' | 'phone_number.stock_available' | 'sms.registration.action_required' | 'sms.registration.status_updated' | 'branded_calling.identity.status_updated' | 'branded_calling.identity.action_required' | 'branded_calling.number.status_updated' | 'rcs.agent.status_updated' | 'verification.approved' | 'verification.failed' | 'commerce.product.created' | 'commerce.product.updated' | 'commerce.product.deleted' | 'commerce.order.created' | 'commerce.order.updated' | 'commerce.order.refunded' | 'api.changelog.published';
|
|
28897
29070
|
};
|
|
28898
29071
|
};
|
|
28899
29072
|
|