@getlatedev/node 0.2.1460 → 0.2.1461
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 +169 -60
- package/dist/index.d.ts +169 -60
- package/dist/index.js +1 -1
- package/dist/index.mjs +1 -1
- package/package.json +1 -1
- package/src/generated/types.gen.ts +175 -59
|
@@ -16778,7 +16778,7 @@ export type Webhook = {
|
|
|
16778
16778
|
/**
|
|
16779
16779
|
* Events subscribed to
|
|
16780
16780
|
*/
|
|
16781
|
-
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.permissions_changed' | 'account.ads.initial_sync_completed' | 'account.ads.sync_failed' | 'account.ads.sync_recovered' | 'analytics.synced' | 'post.tracking_completed' | 'post.authenticity_changed' | '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' | 'review.deleted' | 'review.restored' | 'lead.received' | 'ad.status_changed' | 'ad.review.approved' | 'ad.review.rejected' | 'ad.delivery_issue' | 'campaign.budget.depleted' | 'ad_account.status_changed' | 'ad.video.processed' | 'ad_rule.triggered' | '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' | 'campaign_submission.received' | 'campaign_submission.flagged' | 'campaign_submission.pending_review' | 'campaign_submission.approved' | 'campaign_submission.rejected' | 'creator_campaign.budget_exhausted' | 'creator_campaign.closed' | 'campaign_payout.payable' | 'campaign_payout.settled' | 'campaign_payout.failed' | 'campaign_participant.joined' | 'campaign_participant.suspended' | 'campaign_participant.removed' | 'account.rate_limited' | 'calendar.event.created' | 'calendar.event.updated' | 'calendar.event.deleted' | 'file.created' | 'file.updated' | 'file.deleted' | 'file.picked' | 'contact.updated' | 'contact.deleted')>;
|
|
16781
|
+
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.permissions_changed' | 'account.ads.initial_sync_completed' | 'account.ads.sync_failed' | 'account.ads.sync_recovered' | 'analytics.synced' | 'post.tracking_completed' | 'post.authenticity_changed' | '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' | 'review.deleted' | 'review.restored' | 'lead.received' | 'ad.status_changed' | 'ad.review.approved' | 'ad.review.rejected' | 'ad.delivery_issue' | 'campaign.budget.depleted' | 'ad_account.status_changed' | 'ad.video.processed' | 'ad_rule.triggered' | 'automation.check.completed' | 'automation.action.applied' | 'automation.action.failed' | 'automation.action.unknown' | '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' | 'campaign_submission.received' | 'campaign_submission.flagged' | 'campaign_submission.pending_review' | 'campaign_submission.approved' | 'campaign_submission.rejected' | 'creator_campaign.budget_exhausted' | 'creator_campaign.closed' | 'campaign_payout.payable' | 'campaign_payout.settled' | 'campaign_payout.failed' | 'campaign_participant.joined' | 'campaign_participant.suspended' | 'campaign_participant.removed' | 'account.rate_limited' | 'calendar.event.created' | 'calendar.event.updated' | 'calendar.event.deleted' | 'file.created' | 'file.updated' | 'file.deleted' | 'file.picked' | 'contact.updated' | 'contact.deleted')>;
|
|
16782
16782
|
/**
|
|
16783
16783
|
* Whether webhook delivery is enabled
|
|
16784
16784
|
*/
|
|
@@ -16875,6 +16875,17 @@ export type WebhookAdsSyncAdAccount = {
|
|
|
16875
16875
|
name: (string) | null;
|
|
16876
16876
|
};
|
|
16877
16877
|
|
|
16878
|
+
export type WebhookAutomationRef = {
|
|
16879
|
+
/**
|
|
16880
|
+
* The automation's id: the ad rule id for `ad_rule`.
|
|
16881
|
+
*/
|
|
16882
|
+
id: string;
|
|
16883
|
+
/**
|
|
16884
|
+
* The product the automation belongs to: `ad_rule` today. New values may be added.
|
|
16885
|
+
*/
|
|
16886
|
+
kind: string;
|
|
16887
|
+
};
|
|
16888
|
+
|
|
16878
16889
|
/**
|
|
16879
16890
|
* A single webhook delivery attempt recorded by Zernio (30-day retention).
|
|
16880
16891
|
*/
|
|
@@ -17926,6 +17937,111 @@ export type WebhookPayloadApiChangelogPublished = {
|
|
|
17926
17937
|
|
|
17927
17938
|
export type event15 = 'api.changelog.published';
|
|
17928
17939
|
|
|
17940
|
+
/**
|
|
17941
|
+
* Webhook payload for `automation.action.applied`, `automation.action.failed` and `automation.action.unknown`: one change an automation made or tried.
|
|
17942
|
+
*
|
|
17943
|
+
* Sent once per action as it settles. A refusal decided before any platform call (no live ads, a budget already at its limit) arrives as `automation.action.failed` with `status: skipped`. An `unknown` action is read back by the next check and sent again with its final status.
|
|
17944
|
+
*
|
|
17945
|
+
*/
|
|
17946
|
+
export type WebhookPayloadAutomationAction = {
|
|
17947
|
+
/**
|
|
17948
|
+
* Stable webhook event ID: the dedupe key, also sent as the X-Zernio-Event-Id header and identical on every retry and redelivery.
|
|
17949
|
+
*/
|
|
17950
|
+
id: string;
|
|
17951
|
+
profiles?: WebhookProfiles;
|
|
17952
|
+
/**
|
|
17953
|
+
* Always true when present: only a sample sent by POST /v1/webhooks/test with an event carries it. Real deliveries never do.
|
|
17954
|
+
*/
|
|
17955
|
+
test?: boolean;
|
|
17956
|
+
event: 'automation.action.applied' | 'automation.action.failed' | 'automation.action.unknown';
|
|
17957
|
+
automation: WebhookAutomationRef;
|
|
17958
|
+
/**
|
|
17959
|
+
* The connected account the automation acts on.
|
|
17960
|
+
*/
|
|
17961
|
+
accountId: string;
|
|
17962
|
+
/**
|
|
17963
|
+
* The check that recorded the action.
|
|
17964
|
+
*/
|
|
17965
|
+
checkId: string;
|
|
17966
|
+
action: {
|
|
17967
|
+
id: string;
|
|
17968
|
+
/**
|
|
17969
|
+
* The platform's id of the object changed: an ad, ad set or campaign for ad rules.
|
|
17970
|
+
*/
|
|
17971
|
+
subjectId: string;
|
|
17972
|
+
/**
|
|
17973
|
+
* `pause`, `activate`, `adjust_budget` or `notify` for ad rules. New values may be added.
|
|
17974
|
+
*/
|
|
17975
|
+
type: string;
|
|
17976
|
+
status: 'applied' | 'skipped' | 'failed' | 'unknown';
|
|
17977
|
+
reason: (string) | null;
|
|
17978
|
+
/**
|
|
17979
|
+
* The value before the change, such as `{ "dailyBudget": 40 }`.
|
|
17980
|
+
*/
|
|
17981
|
+
previous: {
|
|
17982
|
+
[key: string]: unknown;
|
|
17983
|
+
} | null;
|
|
17984
|
+
/**
|
|
17985
|
+
* The value the change sets, such as `{ "dailyBudget": 48 }` or `{ "status": "paused" }`.
|
|
17986
|
+
*/
|
|
17987
|
+
target: {
|
|
17988
|
+
[key: string]: unknown;
|
|
17989
|
+
} | null;
|
|
17990
|
+
actedAt: string;
|
|
17991
|
+
};
|
|
17992
|
+
timestamp: string;
|
|
17993
|
+
};
|
|
17994
|
+
|
|
17995
|
+
export type event16 = 'automation.action.applied' | 'automation.action.failed' | 'automation.action.unknown';
|
|
17996
|
+
|
|
17997
|
+
export type status54 = 'applied' | 'skipped' | 'failed' | 'unknown';
|
|
17998
|
+
|
|
17999
|
+
/**
|
|
18000
|
+
* Webhook payload for the `automation.check.completed` event: one scheduled check of an automation finished.
|
|
18001
|
+
*
|
|
18002
|
+
* It fires once per check, whatever the outcome, including checks where nothing matched. Ad rules are the first automations on the engine; `automation.kind` names the product.
|
|
18003
|
+
*
|
|
18004
|
+
*/
|
|
18005
|
+
export type WebhookPayloadAutomationCheckCompleted = {
|
|
18006
|
+
/**
|
|
18007
|
+
* Stable webhook event ID: the dedupe key, also sent as the X-Zernio-Event-Id header and identical on every retry and redelivery.
|
|
18008
|
+
*/
|
|
18009
|
+
id: string;
|
|
18010
|
+
profiles?: WebhookProfiles;
|
|
18011
|
+
/**
|
|
18012
|
+
* Always true when present: only a sample sent by POST /v1/webhooks/test with an event carries it. Real deliveries never do.
|
|
18013
|
+
*/
|
|
18014
|
+
test?: boolean;
|
|
18015
|
+
event: 'automation.check.completed';
|
|
18016
|
+
automation: WebhookAutomationRef;
|
|
18017
|
+
/**
|
|
18018
|
+
* The connected account the automation acts on.
|
|
18019
|
+
*/
|
|
18020
|
+
accountId: string;
|
|
18021
|
+
check: {
|
|
18022
|
+
id: string;
|
|
18023
|
+
/**
|
|
18024
|
+
* The scheduled time the check ran for.
|
|
18025
|
+
*/
|
|
18026
|
+
slot: string;
|
|
18027
|
+
outcome: 'triggered' | 'no_match' | 'cooldown' | 'daily_limit' | 'failed';
|
|
18028
|
+
/**
|
|
18029
|
+
* How many objects the check read.
|
|
18030
|
+
*/
|
|
18031
|
+
subjectsEvaluated: number;
|
|
18032
|
+
/**
|
|
18033
|
+
* How many actions it recorded.
|
|
18034
|
+
*/
|
|
18035
|
+
actionsCount: number;
|
|
18036
|
+
error: (string) | null;
|
|
18037
|
+
};
|
|
18038
|
+
timestamp: string;
|
|
18039
|
+
};
|
|
18040
|
+
|
|
18041
|
+
export type event17 = 'automation.check.completed';
|
|
18042
|
+
|
|
18043
|
+
export type outcome2 = 'triggered' | 'no_match' | 'cooldown' | 'daily_limit' | 'failed';
|
|
18044
|
+
|
|
17929
18045
|
/**
|
|
17930
18046
|
* Webhook payload for calendar.event.created, calendar.event.updated and calendar.event.deleted. Carries the provider event id and the change only; read the event with `GET /v1/calendar/events/{id}` (deleted ids answer 404).
|
|
17931
18047
|
*/
|
|
@@ -17951,7 +18067,7 @@ export type WebhookPayloadCalendarEvent = {
|
|
|
17951
18067
|
timestamp: string;
|
|
17952
18068
|
};
|
|
17953
18069
|
|
|
17954
|
-
export type
|
|
18070
|
+
export type event18 = 'calendar.event.created' | 'calendar.event.updated' | 'calendar.event.deleted';
|
|
17955
18071
|
|
|
17956
18072
|
export type changeType = 'created' | 'updated' | 'deleted';
|
|
17957
18073
|
|
|
@@ -18034,7 +18150,7 @@ export type WebhookPayloadCallEnded = {
|
|
|
18034
18150
|
timestamp: string;
|
|
18035
18151
|
};
|
|
18036
18152
|
|
|
18037
|
-
export type
|
|
18153
|
+
export type event19 = 'call.ended';
|
|
18038
18154
|
|
|
18039
18155
|
/**
|
|
18040
18156
|
* Webhook payload for the `call.failed` event. Fired when a call
|
|
@@ -18073,7 +18189,7 @@ export type WebhookPayloadCallFailed = {
|
|
|
18073
18189
|
timestamp: string;
|
|
18074
18190
|
};
|
|
18075
18191
|
|
|
18076
|
-
export type
|
|
18192
|
+
export type event20 = 'call.failed';
|
|
18077
18193
|
|
|
18078
18194
|
/**
|
|
18079
18195
|
* Webhook payload for the `call.permission_request` event. Fires
|
|
@@ -18115,7 +18231,7 @@ export type WebhookPayloadCallPermissionRequest = {
|
|
|
18115
18231
|
timestamp: string;
|
|
18116
18232
|
};
|
|
18117
18233
|
|
|
18118
|
-
export type
|
|
18234
|
+
export type event21 = 'call.permission_request';
|
|
18119
18235
|
|
|
18120
18236
|
export type response = 'accept' | 'reject';
|
|
18121
18237
|
|
|
@@ -18174,7 +18290,7 @@ export type WebhookPayloadCallReceived = {
|
|
|
18174
18290
|
timestamp: string;
|
|
18175
18291
|
};
|
|
18176
18292
|
|
|
18177
|
-
export type
|
|
18293
|
+
export type event22 = 'call.received';
|
|
18178
18294
|
|
|
18179
18295
|
/**
|
|
18180
18296
|
* Webhook payload for the `campaign.budget.depleted` event. Fires when a campaign
|
|
@@ -18225,7 +18341,7 @@ export type WebhookPayloadCampaignBudgetDepleted = {
|
|
|
18225
18341
|
timestamp: string;
|
|
18226
18342
|
};
|
|
18227
18343
|
|
|
18228
|
-
export type
|
|
18344
|
+
export type event23 = 'campaign.budget.depleted';
|
|
18229
18345
|
|
|
18230
18346
|
/**
|
|
18231
18347
|
* Always `CAMPAIGN`.
|
|
@@ -18268,7 +18384,7 @@ export type WebhookPayloadCampaignParticipant = {
|
|
|
18268
18384
|
timestamp: string;
|
|
18269
18385
|
};
|
|
18270
18386
|
|
|
18271
|
-
export type
|
|
18387
|
+
export type event24 = 'campaign_participant.joined' | 'campaign_participant.suspended' | 'campaign_participant.removed';
|
|
18272
18388
|
|
|
18273
18389
|
/**
|
|
18274
18390
|
* Webhook payload for `campaign_payout.payable` and `campaign_payout.settled`.
|
|
@@ -18357,7 +18473,7 @@ export type WebhookPayloadCampaignPayout = {
|
|
|
18357
18473
|
timestamp: string;
|
|
18358
18474
|
};
|
|
18359
18475
|
|
|
18360
|
-
export type
|
|
18476
|
+
export type event25 = 'campaign_payout.payable' | 'campaign_payout.settled' | 'campaign_payout.failed';
|
|
18361
18477
|
|
|
18362
18478
|
/**
|
|
18363
18479
|
* returned: Stripe refused the transfer. stale: it could not be confirmed with Stripe within 24 hours. reversed: Stripe reversed it after it was sent; the settlement is undone.
|
|
@@ -18425,7 +18541,7 @@ export type WebhookPayloadCampaignSubmission = {
|
|
|
18425
18541
|
timestamp: string;
|
|
18426
18542
|
};
|
|
18427
18543
|
|
|
18428
|
-
export type
|
|
18544
|
+
export type event26 = 'campaign_submission.received' | 'campaign_submission.flagged' | 'campaign_submission.pending_review' | 'campaign_submission.approved' | 'campaign_submission.rejected';
|
|
18429
18545
|
|
|
18430
18546
|
/**
|
|
18431
18547
|
* 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.
|
|
@@ -18592,7 +18708,7 @@ export type WebhookPayloadComment = {
|
|
|
18592
18708
|
timestamp: string;
|
|
18593
18709
|
};
|
|
18594
18710
|
|
|
18595
|
-
export type
|
|
18711
|
+
export type event27 = 'comment.received';
|
|
18596
18712
|
|
|
18597
18713
|
export type platform16 = 'instagram' | 'facebook' | 'threads' | 'youtube' | 'linkedin' | 'bluesky' | 'reddit' | 'tiktok';
|
|
18598
18714
|
|
|
@@ -18638,7 +18754,7 @@ export type WebhookPayloadCommerceOrder = {
|
|
|
18638
18754
|
};
|
|
18639
18755
|
};
|
|
18640
18756
|
|
|
18641
|
-
export type
|
|
18757
|
+
export type event28 = 'commerce.order.created' | 'commerce.order.updated' | 'commerce.order.refunded';
|
|
18642
18758
|
|
|
18643
18759
|
export type type21 = 'order';
|
|
18644
18760
|
|
|
@@ -18681,7 +18797,7 @@ export type WebhookPayloadCommerceProduct = {
|
|
|
18681
18797
|
};
|
|
18682
18798
|
};
|
|
18683
18799
|
|
|
18684
|
-
export type
|
|
18800
|
+
export type event29 = 'commerce.product.created' | 'commerce.product.updated' | 'commerce.product.deleted';
|
|
18685
18801
|
|
|
18686
18802
|
export type type22 = 'product';
|
|
18687
18803
|
|
|
@@ -18710,7 +18826,7 @@ export type WebhookPayloadContact = {
|
|
|
18710
18826
|
timestamp: string;
|
|
18711
18827
|
};
|
|
18712
18828
|
|
|
18713
|
-
export type
|
|
18829
|
+
export type event30 = 'contact.updated' | 'contact.deleted';
|
|
18714
18830
|
|
|
18715
18831
|
export type changeType2 = 'updated' | 'deleted';
|
|
18716
18832
|
|
|
@@ -18750,7 +18866,7 @@ export type WebhookPayloadContactFieldChanged = {
|
|
|
18750
18866
|
source: 'api' | 'workflow' | 'automation';
|
|
18751
18867
|
};
|
|
18752
18868
|
|
|
18753
|
-
export type
|
|
18869
|
+
export type event31 = 'contact.field_changed';
|
|
18754
18870
|
|
|
18755
18871
|
/**
|
|
18756
18872
|
* Who wrote the field: the API or dashboard, a workflow set_field node, or an automation.
|
|
@@ -18782,7 +18898,7 @@ export type WebhookPayloadContactTag = {
|
|
|
18782
18898
|
source: 'api' | 'workflow' | 'automation';
|
|
18783
18899
|
};
|
|
18784
18900
|
|
|
18785
|
-
export type
|
|
18901
|
+
export type event32 = 'contact.tag_added' | 'contact.tag_removed';
|
|
18786
18902
|
|
|
18787
18903
|
/**
|
|
18788
18904
|
* Who answers a conversation changed under Meta's handover protocol. WhatsApp: Meta
|
|
@@ -18828,7 +18944,7 @@ export type WebhookPayloadConversationControlChanged = {
|
|
|
18828
18944
|
timestamp: string;
|
|
18829
18945
|
};
|
|
18830
18946
|
|
|
18831
|
-
export type
|
|
18947
|
+
export type event33 = 'conversation.control_changed';
|
|
18832
18948
|
|
|
18833
18949
|
/**
|
|
18834
18950
|
* 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).
|
|
@@ -18877,7 +18993,7 @@ export type WebhookPayloadConversationStarted = {
|
|
|
18877
18993
|
timestamp: string;
|
|
18878
18994
|
};
|
|
18879
18995
|
|
|
18880
|
-
export type
|
|
18996
|
+
export type event34 = 'conversation.started';
|
|
18881
18997
|
|
|
18882
18998
|
/**
|
|
18883
18999
|
* Webhook payload for `creator_campaign.budget_exhausted` and `creator_campaign.closed`.
|
|
@@ -18916,7 +19032,7 @@ export type WebhookPayloadCreatorCampaign = {
|
|
|
18916
19032
|
timestamp: string;
|
|
18917
19033
|
};
|
|
18918
19034
|
|
|
18919
|
-
export type
|
|
19035
|
+
export type event35 = 'creator_campaign.budget_exhausted' | 'creator_campaign.closed';
|
|
18920
19036
|
|
|
18921
19037
|
/**
|
|
18922
19038
|
* Webhook payload for post.external.created / post.external.updated /
|
|
@@ -18953,7 +19069,7 @@ export type WebhookPayloadExternalPost = {
|
|
|
18953
19069
|
timestamp: string;
|
|
18954
19070
|
};
|
|
18955
19071
|
|
|
18956
|
-
export type
|
|
19072
|
+
export type event36 = 'post.external.created' | 'post.external.updated' | 'post.external.deleted';
|
|
18957
19073
|
|
|
18958
19074
|
/**
|
|
18959
19075
|
* Webhook payload for file.created, file.updated and file.deleted. Carries the provider file id and the change only; read the file with `GET /v1/files/{id}`.
|
|
@@ -18980,7 +19096,7 @@ export type WebhookPayloadFile = {
|
|
|
18980
19096
|
timestamp: string;
|
|
18981
19097
|
};
|
|
18982
19098
|
|
|
18983
|
-
export type
|
|
19099
|
+
export type event37 = 'file.created' | 'file.updated' | 'file.deleted';
|
|
18984
19100
|
|
|
18985
19101
|
/**
|
|
18986
19102
|
* Webhook payload for file.picked: the user picked files on a hosted picker page (`POST /v1/files/picker-sessions`), so the app may now open them. Every id was checked against Drive before the event fired.
|
|
@@ -19015,7 +19131,7 @@ export type WebhookPayloadFilePicked = {
|
|
|
19015
19131
|
timestamp: string;
|
|
19016
19132
|
};
|
|
19017
19133
|
|
|
19018
|
-
export type
|
|
19134
|
+
export type event38 = 'file.picked';
|
|
19019
19135
|
|
|
19020
19136
|
/**
|
|
19021
19137
|
* Webhook payload for lead.received events (Meta Lead Gen / Instant Forms).
|
|
@@ -19095,7 +19211,7 @@ export type WebhookPayloadLead = {
|
|
|
19095
19211
|
timestamp: string;
|
|
19096
19212
|
};
|
|
19097
19213
|
|
|
19098
|
-
export type
|
|
19214
|
+
export type event39 = 'lead.received';
|
|
19099
19215
|
|
|
19100
19216
|
export type platform17 = 'facebook';
|
|
19101
19217
|
|
|
@@ -19675,7 +19791,7 @@ export type WebhookPayloadMessage = {
|
|
|
19675
19791
|
timestamp: string;
|
|
19676
19792
|
};
|
|
19677
19793
|
|
|
19678
|
-
export type
|
|
19794
|
+
export type event40 = 'message.received';
|
|
19679
19795
|
|
|
19680
19796
|
/**
|
|
19681
19797
|
* Which Zernio surface produced the message. Always present and
|
|
@@ -19734,7 +19850,7 @@ export type WebhookPayloadMessageDeleted = {
|
|
|
19734
19850
|
timestamp: string;
|
|
19735
19851
|
};
|
|
19736
19852
|
|
|
19737
|
-
export type
|
|
19853
|
+
export type event41 = 'message.deleted';
|
|
19738
19854
|
|
|
19739
19855
|
/**
|
|
19740
19856
|
* Shared payload for message.delivered, message.read, message.played and message.failed events. Fires when the platform reports a new delivery state for an outgoing message.
|
|
@@ -19798,7 +19914,7 @@ export type WebhookPayloadMessageDeliveryStatus = {
|
|
|
19798
19914
|
timestamp: string;
|
|
19799
19915
|
};
|
|
19800
19916
|
|
|
19801
|
-
export type
|
|
19917
|
+
export type event42 = 'message.delivered' | 'message.read' | 'message.played' | 'message.failed';
|
|
19802
19918
|
|
|
19803
19919
|
/**
|
|
19804
19920
|
* Webhook payload for message.edited events. Fires when the sender
|
|
@@ -19841,7 +19957,7 @@ export type WebhookPayloadMessageEdited = {
|
|
|
19841
19957
|
timestamp: string;
|
|
19842
19958
|
};
|
|
19843
19959
|
|
|
19844
|
-
export type
|
|
19960
|
+
export type event43 = 'message.edited';
|
|
19845
19961
|
|
|
19846
19962
|
/**
|
|
19847
19963
|
* Webhook payload for message sent events (fired when a message is sent via the API, or from the WhatsApp Business app on Coexistence numbers)
|
|
@@ -20087,7 +20203,7 @@ export type WebhookPayloadMessageSent = {
|
|
|
20087
20203
|
timestamp: string;
|
|
20088
20204
|
};
|
|
20089
20205
|
|
|
20090
|
-
export type
|
|
20206
|
+
export type event44 = 'message.sent';
|
|
20091
20207
|
|
|
20092
20208
|
/**
|
|
20093
20209
|
* Every platform whose outgoing messages Zernio observes. sms is absent on purpose: its carrier receipts update delivery status and never raise message.sent.
|
|
@@ -20152,7 +20268,7 @@ export type WebhookPayloadPhoneNumberStockAvailable = {
|
|
|
20152
20268
|
timestamp: string;
|
|
20153
20269
|
};
|
|
20154
20270
|
|
|
20155
|
-
export type
|
|
20271
|
+
export type event45 = 'phone_number.stock_available';
|
|
20156
20272
|
|
|
20157
20273
|
/**
|
|
20158
20274
|
* Webhook payload for post events
|
|
@@ -20207,7 +20323,7 @@ export type WebhookPayloadPost = {
|
|
|
20207
20323
|
timestamp: string;
|
|
20208
20324
|
};
|
|
20209
20325
|
|
|
20210
|
-
export type
|
|
20326
|
+
export type event46 = 'post.scheduled' | 'post.published' | 'post.failed' | 'post.partial' | 'post.cancelled' | 'post.recycled';
|
|
20211
20327
|
|
|
20212
20328
|
/**
|
|
20213
20329
|
* Webhook payload for `post.authenticity_changed`. Fired when a tracked post's
|
|
@@ -20271,7 +20387,7 @@ export type WebhookPayloadPostAuthenticityChanged = {
|
|
|
20271
20387
|
timestamp: string;
|
|
20272
20388
|
};
|
|
20273
20389
|
|
|
20274
|
-
export type
|
|
20390
|
+
export type event47 = 'post.authenticity_changed';
|
|
20275
20391
|
|
|
20276
20392
|
/**
|
|
20277
20393
|
* Webhook payload for these per-platform events:
|
|
@@ -20387,12 +20503,12 @@ export type WebhookPayloadPostPlatform = {
|
|
|
20387
20503
|
timestamp: string;
|
|
20388
20504
|
};
|
|
20389
20505
|
|
|
20390
|
-
export type
|
|
20506
|
+
export type event48 = 'post.platform.published' | 'post.platform.failed' | 'post.platform.deleted' | 'post.tiktok.url_resolved';
|
|
20391
20507
|
|
|
20392
20508
|
/**
|
|
20393
20509
|
* Terminal status this event fires on. Matches the event suffix.
|
|
20394
20510
|
*/
|
|
20395
|
-
export type
|
|
20511
|
+
export type status55 = 'published' | 'failed' | 'deleted';
|
|
20396
20512
|
|
|
20397
20513
|
/**
|
|
20398
20514
|
* Webhook payload for `post.tracking_completed`. Fired once when a post's tracking window ends and its final analytics read has run.
|
|
@@ -20460,7 +20576,7 @@ export type WebhookPayloadPostTrackingCompleted = {
|
|
|
20460
20576
|
timestamp: string;
|
|
20461
20577
|
};
|
|
20462
20578
|
|
|
20463
|
-
export type
|
|
20579
|
+
export type event49 = 'post.tracking_completed';
|
|
20464
20580
|
|
|
20465
20581
|
export type completionReason2 = 'final_read' | 'unreachable' | 'post_deleted';
|
|
20466
20582
|
|
|
@@ -20522,7 +20638,7 @@ export type WebhookPayloadReaction = {
|
|
|
20522
20638
|
timestamp: string;
|
|
20523
20639
|
};
|
|
20524
20640
|
|
|
20525
|
-
export type
|
|
20641
|
+
export type event50 = 'reaction.received';
|
|
20526
20642
|
|
|
20527
20643
|
export type action = 'added' | 'removed';
|
|
20528
20644
|
|
|
@@ -20601,7 +20717,7 @@ export type WebhookPayloadReferral = {
|
|
|
20601
20717
|
timestamp: string;
|
|
20602
20718
|
};
|
|
20603
20719
|
|
|
20604
|
-
export type
|
|
20720
|
+
export type event51 = 'referral.received';
|
|
20605
20721
|
|
|
20606
20722
|
/**
|
|
20607
20723
|
* Webhook payload for the review.deleted event.
|
|
@@ -20659,7 +20775,7 @@ export type WebhookPayloadReviewDeleted = {
|
|
|
20659
20775
|
timestamp: string;
|
|
20660
20776
|
};
|
|
20661
20777
|
|
|
20662
|
-
export type
|
|
20778
|
+
export type event52 = 'review.deleted';
|
|
20663
20779
|
|
|
20664
20780
|
/**
|
|
20665
20781
|
* Webhook payload for the review.new event (new review posted on a connected account).
|
|
@@ -20691,7 +20807,7 @@ export type WebhookPayloadReviewNew = {
|
|
|
20691
20807
|
timestamp: string;
|
|
20692
20808
|
};
|
|
20693
20809
|
|
|
20694
|
-
export type
|
|
20810
|
+
export type event53 = 'review.new';
|
|
20695
20811
|
|
|
20696
20812
|
/**
|
|
20697
20813
|
* Webhook payload for the review.restored event. Same shape as review.new.
|
|
@@ -20726,7 +20842,7 @@ export type WebhookPayloadReviewRestored = {
|
|
|
20726
20842
|
timestamp: string;
|
|
20727
20843
|
};
|
|
20728
20844
|
|
|
20729
|
-
export type
|
|
20845
|
+
export type event54 = 'review.restored';
|
|
20730
20846
|
|
|
20731
20847
|
/**
|
|
20732
20848
|
* Webhook payload for the review.updated event. Same shape as review.new.
|
|
@@ -20774,7 +20890,7 @@ export type WebhookPayloadReviewUpdated = {
|
|
|
20774
20890
|
timestamp: string;
|
|
20775
20891
|
};
|
|
20776
20892
|
|
|
20777
|
-
export type
|
|
20893
|
+
export type event55 = 'review.updated';
|
|
20778
20894
|
|
|
20779
20895
|
export type WebhookPayloadSequenceEnrollment = {
|
|
20780
20896
|
/**
|
|
@@ -20807,7 +20923,7 @@ export type WebhookPayloadSequenceEnrollment = {
|
|
|
20807
20923
|
exitReason?: 'completed' | 'replied' | 'manual' | 'failed' | 'unsubscribed';
|
|
20808
20924
|
};
|
|
20809
20925
|
|
|
20810
|
-
export type
|
|
20926
|
+
export type event56 = 'sequence.enrolled' | 'sequence.exited';
|
|
20811
20927
|
|
|
20812
20928
|
/**
|
|
20813
20929
|
* 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.
|
|
@@ -20828,7 +20944,7 @@ export type WebhookPayloadSupportRun = {
|
|
|
20828
20944
|
run: SupportRun;
|
|
20829
20945
|
};
|
|
20830
20946
|
|
|
20831
|
-
export type
|
|
20947
|
+
export type event57 = 'support.run.completed' | 'support.run.failed';
|
|
20832
20948
|
|
|
20833
20949
|
/**
|
|
20834
20950
|
* Webhook payload for test deliveries
|
|
@@ -20849,7 +20965,7 @@ export type WebhookPayloadTest = {
|
|
|
20849
20965
|
timestamp: string;
|
|
20850
20966
|
};
|
|
20851
20967
|
|
|
20852
|
-
export type
|
|
20968
|
+
export type event58 = 'webhook.test';
|
|
20853
20969
|
|
|
20854
20970
|
/**
|
|
20855
20971
|
* Webhook payload for `whatsapp.account.alert_received`, forwarded from Meta's
|
|
@@ -20901,7 +21017,7 @@ export type WebhookPayloadWhatsAppAccountAlertReceived = {
|
|
|
20901
21017
|
timestamp: string;
|
|
20902
21018
|
};
|
|
20903
21019
|
|
|
20904
|
-
export type
|
|
21020
|
+
export type event59 = 'whatsapp.account.alert_received';
|
|
20905
21021
|
|
|
20906
21022
|
export type platform19 = 'whatsapp';
|
|
20907
21023
|
|
|
@@ -20953,12 +21069,12 @@ export type WebhookPayloadWhatsAppAccountNameStatusUpdated = {
|
|
|
20953
21069
|
timestamp: string;
|
|
20954
21070
|
};
|
|
20955
21071
|
|
|
20956
|
-
export type
|
|
21072
|
+
export type event60 = 'whatsapp.account.name_status_updated';
|
|
20957
21073
|
|
|
20958
21074
|
/**
|
|
20959
21075
|
* Normalized from Meta's `decision` (REJECTED -> DECLINED, DEFERRED -> PENDING_REVIEW; the review is still open on DEFERRED, not a rejection).
|
|
20960
21076
|
*/
|
|
20961
|
-
export type
|
|
21077
|
+
export type status56 = 'APPROVED' | 'DECLINED' | 'PENDING_REVIEW';
|
|
20962
21078
|
|
|
20963
21079
|
/**
|
|
20964
21080
|
* Webhook payload for `whatsapp.account.quality_updated`. Fired when a connected
|
|
@@ -21011,7 +21127,7 @@ export type WebhookPayloadWhatsAppAccountQualityUpdated = {
|
|
|
21011
21127
|
timestamp: string;
|
|
21012
21128
|
};
|
|
21013
21129
|
|
|
21014
|
-
export type
|
|
21130
|
+
export type event61 = 'whatsapp.account.quality_updated';
|
|
21015
21131
|
|
|
21016
21132
|
/**
|
|
21017
21133
|
* The Meta webhook field that reported the change.
|
|
@@ -21087,12 +21203,12 @@ export type WebhookPayloadWhatsAppAccountStatusUpdated = {
|
|
|
21087
21203
|
timestamp: string;
|
|
21088
21204
|
};
|
|
21089
21205
|
|
|
21090
|
-
export type
|
|
21206
|
+
export type event62 = 'whatsapp.account.status_updated';
|
|
21091
21207
|
|
|
21092
21208
|
/**
|
|
21093
21209
|
* `active` only on a reinstatement (DISABLED_UPDATE with ban state REINSTATE).
|
|
21094
21210
|
*/
|
|
21095
|
-
export type
|
|
21211
|
+
export type status57 = 'restricted' | 'active';
|
|
21096
21212
|
|
|
21097
21213
|
/**
|
|
21098
21214
|
* Webhook payload for the `whatsapp.contact.identity_changed` event. Fired when
|
|
@@ -21144,7 +21260,7 @@ export type WebhookPayloadWhatsAppContactIdentityChanged = {
|
|
|
21144
21260
|
timestamp: string;
|
|
21145
21261
|
};
|
|
21146
21262
|
|
|
21147
|
-
export type
|
|
21263
|
+
export type event63 = 'whatsapp.contact.identity_changed';
|
|
21148
21264
|
|
|
21149
21265
|
/**
|
|
21150
21266
|
* Which Meta signal reported the change. `user_changed_number`: new phone number. `user_changed_user_id` and `user_id_update`: new BSUID.
|
|
@@ -21218,7 +21334,7 @@ export type WebhookPayloadWhatsAppTemplateCategoryUpdated = {
|
|
|
21218
21334
|
timestamp: string;
|
|
21219
21335
|
};
|
|
21220
21336
|
|
|
21221
|
-
export type
|
|
21337
|
+
export type event64 = 'whatsapp.template.category_updated';
|
|
21222
21338
|
|
|
21223
21339
|
/**
|
|
21224
21340
|
* `scheduled` is Meta's 24h advance notice of an upcoming
|
|
@@ -21300,7 +21416,7 @@ export type WebhookPayloadWhatsAppTemplateStatusUpdated = {
|
|
|
21300
21416
|
timestamp: string;
|
|
21301
21417
|
};
|
|
21302
21418
|
|
|
21303
|
-
export type
|
|
21419
|
+
export type event65 = 'whatsapp.template.status_updated';
|
|
21304
21420
|
|
|
21305
21421
|
/**
|
|
21306
21422
|
* New status. Forwarded verbatim from Meta's `event` field.
|
|
@@ -21308,7 +21424,7 @@ export type event63 = 'whatsapp.template.status_updated';
|
|
|
21308
21424
|
* request before the template is actually removed.
|
|
21309
21425
|
*
|
|
21310
21426
|
*/
|
|
21311
|
-
export type
|
|
21427
|
+
export type status58 = 'APPROVED' | 'REJECTED' | 'PENDING' | 'PAUSED' | 'DISABLED' | 'IN_APPEAL' | 'PENDING_DELETION';
|
|
21312
21428
|
|
|
21313
21429
|
export type WebhookPayloadWorkflowRun = {
|
|
21314
21430
|
/**
|
|
@@ -21367,12 +21483,12 @@ export type WebhookPayloadWorkflowRun = {
|
|
|
21367
21483
|
error?: string;
|
|
21368
21484
|
};
|
|
21369
21485
|
|
|
21370
|
-
export type
|
|
21486
|
+
export type event66 = 'workflow.run.started' | 'workflow.run.completed' | 'workflow.run.failed';
|
|
21371
21487
|
|
|
21372
21488
|
/**
|
|
21373
21489
|
* 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.
|
|
21374
21490
|
*/
|
|
21375
|
-
export type
|
|
21491
|
+
export type status59 = 'running' | 'waiting' | 'completed' | 'exited' | 'failed';
|
|
21376
21492
|
|
|
21377
21493
|
/**
|
|
21378
21494
|
* The profiles this event belongs to, each with the externalId you set on it (null when none is set). Use it to route the event to your tenant without storing Zernio profile ids.
|
|
@@ -21772,7 +21888,7 @@ export type WorkflowExecutionEvent = {
|
|
|
21772
21888
|
|
|
21773
21889
|
export type action2 = 'execution_started' | 'execution_completed' | 'execution_exited' | 'execution_paused' | 'execution_resumed' | 'node_started' | 'node_completed' | 'node_failed' | 'node_skipped';
|
|
21774
21890
|
|
|
21775
|
-
export type
|
|
21891
|
+
export type status60 = 'success' | 'failed' | 'pending';
|
|
21776
21892
|
|
|
21777
21893
|
/**
|
|
21778
21894
|
* A node in a workflow graph. `config` shape depends on `type`.
|
|
@@ -35501,7 +35617,7 @@ export type CreateWebhookSettingsData = {
|
|
|
35501
35617
|
/**
|
|
35502
35618
|
* Events to subscribe to (at least one required)
|
|
35503
35619
|
*/
|
|
35504
|
-
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.permissions_changed' | 'account.ads.initial_sync_completed' | 'account.ads.sync_failed' | 'account.ads.sync_recovered' | 'analytics.synced' | 'post.tracking_completed' | 'post.authenticity_changed' | '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' | 'review.deleted' | 'review.restored' | 'lead.received' | 'ad.status_changed' | 'ad.review.approved' | 'ad.review.rejected' | 'ad.delivery_issue' | 'campaign.budget.depleted' | 'ad_account.status_changed' | 'ad.video.processed' | 'ad_rule.triggered' | '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' | 'campaign_submission.received' | 'campaign_submission.flagged' | 'campaign_submission.pending_review' | 'campaign_submission.approved' | 'campaign_submission.rejected' | 'creator_campaign.budget_exhausted' | 'creator_campaign.closed' | 'campaign_payout.payable' | 'campaign_payout.settled' | 'campaign_payout.failed' | 'campaign_participant.joined' | 'campaign_participant.suspended' | 'campaign_participant.removed')>;
|
|
35620
|
+
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.permissions_changed' | 'account.ads.initial_sync_completed' | 'account.ads.sync_failed' | 'account.ads.sync_recovered' | 'analytics.synced' | 'post.tracking_completed' | 'post.authenticity_changed' | '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' | 'review.deleted' | 'review.restored' | 'lead.received' | 'ad.status_changed' | 'ad.review.approved' | 'ad.review.rejected' | 'ad.delivery_issue' | 'campaign.budget.depleted' | 'ad_account.status_changed' | 'ad.video.processed' | 'ad_rule.triggered' | 'automation.check.completed' | 'automation.action.applied' | 'automation.action.failed' | 'automation.action.unknown' | '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' | 'campaign_submission.received' | 'campaign_submission.flagged' | 'campaign_submission.pending_review' | 'campaign_submission.approved' | 'campaign_submission.rejected' | 'creator_campaign.budget_exhausted' | 'creator_campaign.closed' | 'campaign_payout.payable' | 'campaign_payout.settled' | 'campaign_payout.failed' | 'campaign_participant.joined' | 'campaign_participant.suspended' | 'campaign_participant.removed')>;
|
|
35505
35621
|
/**
|
|
35506
35622
|
* Enable or disable webhook delivery. Defaults to `true` when omitted.
|
|
35507
35623
|
*/
|
|
@@ -35573,7 +35689,7 @@ export type UpdateWebhookSettingsData = {
|
|
|
35573
35689
|
/**
|
|
35574
35690
|
* Events to subscribe to. Must contain at least one event if provided.
|
|
35575
35691
|
*/
|
|
35576
|
-
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.permissions_changed' | 'account.ads.initial_sync_completed' | 'account.ads.sync_failed' | 'account.ads.sync_recovered' | 'analytics.synced' | 'post.tracking_completed' | 'post.authenticity_changed' | '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' | 'review.deleted' | 'review.restored' | 'lead.received' | 'ad.status_changed' | 'ad.review.approved' | 'ad.review.rejected' | 'ad.delivery_issue' | 'campaign.budget.depleted' | 'ad_account.status_changed' | 'ad.video.processed' | 'ad_rule.triggered' | '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' | 'campaign_submission.received' | 'campaign_submission.flagged' | 'campaign_submission.pending_review' | 'campaign_submission.approved' | 'campaign_submission.rejected' | 'creator_campaign.budget_exhausted' | 'creator_campaign.closed' | 'campaign_payout.payable' | 'campaign_payout.settled' | 'campaign_payout.failed' | 'campaign_participant.joined' | 'campaign_participant.suspended' | 'campaign_participant.removed')>;
|
|
35692
|
+
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.permissions_changed' | 'account.ads.initial_sync_completed' | 'account.ads.sync_failed' | 'account.ads.sync_recovered' | 'analytics.synced' | 'post.tracking_completed' | 'post.authenticity_changed' | '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' | 'review.deleted' | 'review.restored' | 'lead.received' | 'ad.status_changed' | 'ad.review.approved' | 'ad.review.rejected' | 'ad.delivery_issue' | 'campaign.budget.depleted' | 'ad_account.status_changed' | 'ad.video.processed' | 'ad_rule.triggered' | 'automation.check.completed' | 'automation.action.applied' | 'automation.action.failed' | 'automation.action.unknown' | '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' | 'campaign_submission.received' | 'campaign_submission.flagged' | 'campaign_submission.pending_review' | 'campaign_submission.approved' | 'campaign_submission.rejected' | 'creator_campaign.budget_exhausted' | 'creator_campaign.closed' | 'campaign_payout.payable' | 'campaign_payout.settled' | 'campaign_payout.failed' | 'campaign_participant.joined' | 'campaign_participant.suspended' | 'campaign_participant.removed')>;
|
|
35577
35693
|
/**
|
|
35578
35694
|
* Enable or disable webhook delivery
|
|
35579
35695
|
*/
|
|
@@ -35762,7 +35878,7 @@ export type TestWebhookData = {
|
|
|
35762
35878
|
/**
|
|
35763
35879
|
* Send a sample payload of this event instead of `webhook.test`. The sample is marked with `test: true`.
|
|
35764
35880
|
*/
|
|
35765
|
-
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.permissions_changed' | 'account.ads.initial_sync_completed' | 'account.ads.sync_failed' | 'account.ads.sync_recovered' | 'account.rate_limited' | 'calendar.event.created' | 'calendar.event.updated' | 'calendar.event.deleted' | 'file.created' | 'file.updated' | 'file.deleted' | 'file.picked' | 'contact.updated' | 'contact.deleted' | 'analytics.synced' | 'post.tracking_completed' | 'post.authenticity_changed' | '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' | 'campaign_submission.received' | 'campaign_submission.flagged' | 'campaign_submission.pending_review' | 'campaign_submission.approved' | 'campaign_submission.rejected' | 'creator_campaign.budget_exhausted' | 'creator_campaign.closed' | 'campaign_payout.payable' | 'campaign_payout.settled' | 'campaign_payout.failed' | 'campaign_participant.joined' | 'campaign_participant.suspended' | 'campaign_participant.removed' | 'call.received' | 'call.ended' | 'call.failed' | 'call.permission_request' | 'comment.received' | 'review.new' | 'review.updated' | 'review.deleted' | 'review.restored' | 'ad.status_changed' | 'ad.review.approved' | 'ad.review.rejected' | 'ad.delivery_issue' | 'campaign.budget.depleted' | 'ad_account.status_changed' | 'ad.video.processed' | 'ad_rule.triggered' | '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';
|
|
35881
|
+
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.permissions_changed' | 'account.ads.initial_sync_completed' | 'account.ads.sync_failed' | 'account.ads.sync_recovered' | 'account.rate_limited' | 'calendar.event.created' | 'calendar.event.updated' | 'calendar.event.deleted' | 'file.created' | 'file.updated' | 'file.deleted' | 'file.picked' | 'contact.updated' | 'contact.deleted' | 'analytics.synced' | 'post.tracking_completed' | 'post.authenticity_changed' | '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' | 'campaign_submission.received' | 'campaign_submission.flagged' | 'campaign_submission.pending_review' | 'campaign_submission.approved' | 'campaign_submission.rejected' | 'creator_campaign.budget_exhausted' | 'creator_campaign.closed' | 'campaign_payout.payable' | 'campaign_payout.settled' | 'campaign_payout.failed' | 'campaign_participant.joined' | 'campaign_participant.suspended' | 'campaign_participant.removed' | 'call.received' | 'call.ended' | 'call.failed' | 'call.permission_request' | 'comment.received' | 'review.new' | 'review.updated' | 'review.deleted' | 'review.restored' | 'ad.status_changed' | 'ad.review.approved' | 'ad.review.rejected' | 'ad.delivery_issue' | 'campaign.budget.depleted' | 'ad_account.status_changed' | 'ad.video.processed' | 'ad_rule.triggered' | 'automation.check.completed' | 'automation.action.applied' | 'automation.action.failed' | 'automation.action.unknown' | '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';
|
|
35766
35882
|
};
|
|
35767
35883
|
};
|
|
35768
35884
|
|