@getlatedev/node 0.2.1460 → 0.2.1462
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 +209 -62
- package/dist/index.d.ts +209 -62
- package/dist/index.js +1 -1
- package/dist/index.mjs +1 -1
- package/package.json +1 -1
- package/src/generated/types.gen.ts +215 -61
|
@@ -1691,9 +1691,34 @@ export type AdRule = {
|
|
|
1691
1691
|
|
|
1692
1692
|
export type AdRuleAction = {
|
|
1693
1693
|
/**
|
|
1694
|
-
* Send the `ad_rule.triggered` webhook.
|
|
1694
|
+
* Send the `ad_rule.triggered` webhook, and the alert to every `send` destination.
|
|
1695
1695
|
*/
|
|
1696
1696
|
type: 'notify';
|
|
1697
|
+
/**
|
|
1698
|
+
* Also send a short alert through accounts you connected: what matched, the values and what the rule did. Up to 5 destinations, checked when the rule is saved.
|
|
1699
|
+
*
|
|
1700
|
+
* A destination that fails is reported in the run's `notification`; it never undoes a change.
|
|
1701
|
+
*
|
|
1702
|
+
*/
|
|
1703
|
+
send?: Array<({
|
|
1704
|
+
/**
|
|
1705
|
+
* A connected Slack account (`GET /v1/accounts`, platform `slack`).
|
|
1706
|
+
*/
|
|
1707
|
+
accountId: string;
|
|
1708
|
+
/**
|
|
1709
|
+
* The Slack channel to post in. Defaults to the channel the account was connected with; the bot joins public channels on its own.
|
|
1710
|
+
*/
|
|
1711
|
+
channelId?: string;
|
|
1712
|
+
} | {
|
|
1713
|
+
/**
|
|
1714
|
+
* A connected Gmail or Outlook mailbox with email access.
|
|
1715
|
+
*/
|
|
1716
|
+
accountId: string;
|
|
1717
|
+
/**
|
|
1718
|
+
* The address that receives the alert, sent as a new email from that mailbox.
|
|
1719
|
+
*/
|
|
1720
|
+
to: string;
|
|
1721
|
+
})>;
|
|
1697
1722
|
} | {
|
|
1698
1723
|
/**
|
|
1699
1724
|
* Pause the campaign, ad set or ad.
|
|
@@ -1712,6 +1737,19 @@ export type AdRuleAction = {
|
|
|
1712
1737
|
* At most this many objects changed in any 24 hours, across runs. Matches over the limit are skipped with `daily_limit_reached` and tried again later.
|
|
1713
1738
|
*/
|
|
1714
1739
|
maxChangesPerDay?: number;
|
|
1740
|
+
} | {
|
|
1741
|
+
/**
|
|
1742
|
+
* Set the daily budget to an exact amount, such as a reset every midnight. Same level rules as the percent change.
|
|
1743
|
+
*/
|
|
1744
|
+
type: 'adjust_budget';
|
|
1745
|
+
/**
|
|
1746
|
+
* The daily budget to set, in the ad account currency. An object already at it is skipped with `already_at_amount`.
|
|
1747
|
+
*/
|
|
1748
|
+
amount: number;
|
|
1749
|
+
/**
|
|
1750
|
+
* At most this many objects changed in any 24 hours, across runs. Matches over the limit are skipped with `daily_limit_reached` and tried again later.
|
|
1751
|
+
*/
|
|
1752
|
+
maxChangesPerDay?: number;
|
|
1715
1753
|
} | {
|
|
1716
1754
|
/**
|
|
1717
1755
|
* Change the daily budget. Not on ad-level rules (an ad has no budget), and on Google it needs a campaign-level rule (ad groups have no budget of their own).
|
|
@@ -1733,7 +1771,7 @@ export type AdRuleAction = {
|
|
|
1733
1771
|
};
|
|
1734
1772
|
|
|
1735
1773
|
/**
|
|
1736
|
-
* Send the `ad_rule.triggered` webhook.
|
|
1774
|
+
* Send the `ad_rule.triggered` webhook, and the alert to every `send` destination.
|
|
1737
1775
|
*/
|
|
1738
1776
|
export type type2 = 'notify';
|
|
1739
1777
|
|
|
@@ -16778,7 +16816,7 @@ export type Webhook = {
|
|
|
16778
16816
|
/**
|
|
16779
16817
|
* Events subscribed to
|
|
16780
16818
|
*/
|
|
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')>;
|
|
16819
|
+
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
16820
|
/**
|
|
16783
16821
|
* Whether webhook delivery is enabled
|
|
16784
16822
|
*/
|
|
@@ -16875,6 +16913,17 @@ export type WebhookAdsSyncAdAccount = {
|
|
|
16875
16913
|
name: (string) | null;
|
|
16876
16914
|
};
|
|
16877
16915
|
|
|
16916
|
+
export type WebhookAutomationRef = {
|
|
16917
|
+
/**
|
|
16918
|
+
* The automation's id: the ad rule id for `ad_rule`.
|
|
16919
|
+
*/
|
|
16920
|
+
id: string;
|
|
16921
|
+
/**
|
|
16922
|
+
* The product the automation belongs to: `ad_rule` today. New values may be added.
|
|
16923
|
+
*/
|
|
16924
|
+
kind: string;
|
|
16925
|
+
};
|
|
16926
|
+
|
|
16878
16927
|
/**
|
|
16879
16928
|
* A single webhook delivery attempt recorded by Zernio (30-day retention).
|
|
16880
16929
|
*/
|
|
@@ -17926,6 +17975,111 @@ export type WebhookPayloadApiChangelogPublished = {
|
|
|
17926
17975
|
|
|
17927
17976
|
export type event15 = 'api.changelog.published';
|
|
17928
17977
|
|
|
17978
|
+
/**
|
|
17979
|
+
* Webhook payload for `automation.action.applied`, `automation.action.failed` and `automation.action.unknown`: one change an automation made or tried.
|
|
17980
|
+
*
|
|
17981
|
+
* 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.
|
|
17982
|
+
*
|
|
17983
|
+
*/
|
|
17984
|
+
export type WebhookPayloadAutomationAction = {
|
|
17985
|
+
/**
|
|
17986
|
+
* Stable webhook event ID: the dedupe key, also sent as the X-Zernio-Event-Id header and identical on every retry and redelivery.
|
|
17987
|
+
*/
|
|
17988
|
+
id: string;
|
|
17989
|
+
profiles?: WebhookProfiles;
|
|
17990
|
+
/**
|
|
17991
|
+
* Always true when present: only a sample sent by POST /v1/webhooks/test with an event carries it. Real deliveries never do.
|
|
17992
|
+
*/
|
|
17993
|
+
test?: boolean;
|
|
17994
|
+
event: 'automation.action.applied' | 'automation.action.failed' | 'automation.action.unknown';
|
|
17995
|
+
automation: WebhookAutomationRef;
|
|
17996
|
+
/**
|
|
17997
|
+
* The connected account the automation acts on.
|
|
17998
|
+
*/
|
|
17999
|
+
accountId: string;
|
|
18000
|
+
/**
|
|
18001
|
+
* The check that recorded the action.
|
|
18002
|
+
*/
|
|
18003
|
+
checkId: string;
|
|
18004
|
+
action: {
|
|
18005
|
+
id: string;
|
|
18006
|
+
/**
|
|
18007
|
+
* The platform's id of the object changed: an ad, ad set or campaign for ad rules.
|
|
18008
|
+
*/
|
|
18009
|
+
subjectId: string;
|
|
18010
|
+
/**
|
|
18011
|
+
* `pause`, `activate`, `adjust_budget` or `notify` for ad rules. New values may be added.
|
|
18012
|
+
*/
|
|
18013
|
+
type: string;
|
|
18014
|
+
status: 'applied' | 'skipped' | 'failed' | 'unknown';
|
|
18015
|
+
reason: (string) | null;
|
|
18016
|
+
/**
|
|
18017
|
+
* The value before the change, such as `{ "dailyBudget": 40 }`.
|
|
18018
|
+
*/
|
|
18019
|
+
previous: {
|
|
18020
|
+
[key: string]: unknown;
|
|
18021
|
+
} | null;
|
|
18022
|
+
/**
|
|
18023
|
+
* The value the change sets, such as `{ "dailyBudget": 48 }` or `{ "status": "paused" }`.
|
|
18024
|
+
*/
|
|
18025
|
+
target: {
|
|
18026
|
+
[key: string]: unknown;
|
|
18027
|
+
} | null;
|
|
18028
|
+
actedAt: string;
|
|
18029
|
+
};
|
|
18030
|
+
timestamp: string;
|
|
18031
|
+
};
|
|
18032
|
+
|
|
18033
|
+
export type event16 = 'automation.action.applied' | 'automation.action.failed' | 'automation.action.unknown';
|
|
18034
|
+
|
|
18035
|
+
export type status54 = 'applied' | 'skipped' | 'failed' | 'unknown';
|
|
18036
|
+
|
|
18037
|
+
/**
|
|
18038
|
+
* Webhook payload for the `automation.check.completed` event: one scheduled check of an automation finished.
|
|
18039
|
+
*
|
|
18040
|
+
* 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.
|
|
18041
|
+
*
|
|
18042
|
+
*/
|
|
18043
|
+
export type WebhookPayloadAutomationCheckCompleted = {
|
|
18044
|
+
/**
|
|
18045
|
+
* Stable webhook event ID: the dedupe key, also sent as the X-Zernio-Event-Id header and identical on every retry and redelivery.
|
|
18046
|
+
*/
|
|
18047
|
+
id: string;
|
|
18048
|
+
profiles?: WebhookProfiles;
|
|
18049
|
+
/**
|
|
18050
|
+
* Always true when present: only a sample sent by POST /v1/webhooks/test with an event carries it. Real deliveries never do.
|
|
18051
|
+
*/
|
|
18052
|
+
test?: boolean;
|
|
18053
|
+
event: 'automation.check.completed';
|
|
18054
|
+
automation: WebhookAutomationRef;
|
|
18055
|
+
/**
|
|
18056
|
+
* The connected account the automation acts on.
|
|
18057
|
+
*/
|
|
18058
|
+
accountId: string;
|
|
18059
|
+
check: {
|
|
18060
|
+
id: string;
|
|
18061
|
+
/**
|
|
18062
|
+
* The scheduled time the check ran for.
|
|
18063
|
+
*/
|
|
18064
|
+
slot: string;
|
|
18065
|
+
outcome: 'triggered' | 'no_match' | 'cooldown' | 'daily_limit' | 'failed';
|
|
18066
|
+
/**
|
|
18067
|
+
* How many objects the check read.
|
|
18068
|
+
*/
|
|
18069
|
+
subjectsEvaluated: number;
|
|
18070
|
+
/**
|
|
18071
|
+
* How many actions it recorded.
|
|
18072
|
+
*/
|
|
18073
|
+
actionsCount: number;
|
|
18074
|
+
error: (string) | null;
|
|
18075
|
+
};
|
|
18076
|
+
timestamp: string;
|
|
18077
|
+
};
|
|
18078
|
+
|
|
18079
|
+
export type event17 = 'automation.check.completed';
|
|
18080
|
+
|
|
18081
|
+
export type outcome2 = 'triggered' | 'no_match' | 'cooldown' | 'daily_limit' | 'failed';
|
|
18082
|
+
|
|
17929
18083
|
/**
|
|
17930
18084
|
* 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
18085
|
*/
|
|
@@ -17951,7 +18105,7 @@ export type WebhookPayloadCalendarEvent = {
|
|
|
17951
18105
|
timestamp: string;
|
|
17952
18106
|
};
|
|
17953
18107
|
|
|
17954
|
-
export type
|
|
18108
|
+
export type event18 = 'calendar.event.created' | 'calendar.event.updated' | 'calendar.event.deleted';
|
|
17955
18109
|
|
|
17956
18110
|
export type changeType = 'created' | 'updated' | 'deleted';
|
|
17957
18111
|
|
|
@@ -18034,7 +18188,7 @@ export type WebhookPayloadCallEnded = {
|
|
|
18034
18188
|
timestamp: string;
|
|
18035
18189
|
};
|
|
18036
18190
|
|
|
18037
|
-
export type
|
|
18191
|
+
export type event19 = 'call.ended';
|
|
18038
18192
|
|
|
18039
18193
|
/**
|
|
18040
18194
|
* Webhook payload for the `call.failed` event. Fired when a call
|
|
@@ -18073,7 +18227,7 @@ export type WebhookPayloadCallFailed = {
|
|
|
18073
18227
|
timestamp: string;
|
|
18074
18228
|
};
|
|
18075
18229
|
|
|
18076
|
-
export type
|
|
18230
|
+
export type event20 = 'call.failed';
|
|
18077
18231
|
|
|
18078
18232
|
/**
|
|
18079
18233
|
* Webhook payload for the `call.permission_request` event. Fires
|
|
@@ -18115,7 +18269,7 @@ export type WebhookPayloadCallPermissionRequest = {
|
|
|
18115
18269
|
timestamp: string;
|
|
18116
18270
|
};
|
|
18117
18271
|
|
|
18118
|
-
export type
|
|
18272
|
+
export type event21 = 'call.permission_request';
|
|
18119
18273
|
|
|
18120
18274
|
export type response = 'accept' | 'reject';
|
|
18121
18275
|
|
|
@@ -18174,7 +18328,7 @@ export type WebhookPayloadCallReceived = {
|
|
|
18174
18328
|
timestamp: string;
|
|
18175
18329
|
};
|
|
18176
18330
|
|
|
18177
|
-
export type
|
|
18331
|
+
export type event22 = 'call.received';
|
|
18178
18332
|
|
|
18179
18333
|
/**
|
|
18180
18334
|
* Webhook payload for the `campaign.budget.depleted` event. Fires when a campaign
|
|
@@ -18225,7 +18379,7 @@ export type WebhookPayloadCampaignBudgetDepleted = {
|
|
|
18225
18379
|
timestamp: string;
|
|
18226
18380
|
};
|
|
18227
18381
|
|
|
18228
|
-
export type
|
|
18382
|
+
export type event23 = 'campaign.budget.depleted';
|
|
18229
18383
|
|
|
18230
18384
|
/**
|
|
18231
18385
|
* Always `CAMPAIGN`.
|
|
@@ -18268,7 +18422,7 @@ export type WebhookPayloadCampaignParticipant = {
|
|
|
18268
18422
|
timestamp: string;
|
|
18269
18423
|
};
|
|
18270
18424
|
|
|
18271
|
-
export type
|
|
18425
|
+
export type event24 = 'campaign_participant.joined' | 'campaign_participant.suspended' | 'campaign_participant.removed';
|
|
18272
18426
|
|
|
18273
18427
|
/**
|
|
18274
18428
|
* Webhook payload for `campaign_payout.payable` and `campaign_payout.settled`.
|
|
@@ -18357,7 +18511,7 @@ export type WebhookPayloadCampaignPayout = {
|
|
|
18357
18511
|
timestamp: string;
|
|
18358
18512
|
};
|
|
18359
18513
|
|
|
18360
|
-
export type
|
|
18514
|
+
export type event25 = 'campaign_payout.payable' | 'campaign_payout.settled' | 'campaign_payout.failed';
|
|
18361
18515
|
|
|
18362
18516
|
/**
|
|
18363
18517
|
* 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 +18579,7 @@ export type WebhookPayloadCampaignSubmission = {
|
|
|
18425
18579
|
timestamp: string;
|
|
18426
18580
|
};
|
|
18427
18581
|
|
|
18428
|
-
export type
|
|
18582
|
+
export type event26 = 'campaign_submission.received' | 'campaign_submission.flagged' | 'campaign_submission.pending_review' | 'campaign_submission.approved' | 'campaign_submission.rejected';
|
|
18429
18583
|
|
|
18430
18584
|
/**
|
|
18431
18585
|
* 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 +18746,7 @@ export type WebhookPayloadComment = {
|
|
|
18592
18746
|
timestamp: string;
|
|
18593
18747
|
};
|
|
18594
18748
|
|
|
18595
|
-
export type
|
|
18749
|
+
export type event27 = 'comment.received';
|
|
18596
18750
|
|
|
18597
18751
|
export type platform16 = 'instagram' | 'facebook' | 'threads' | 'youtube' | 'linkedin' | 'bluesky' | 'reddit' | 'tiktok';
|
|
18598
18752
|
|
|
@@ -18638,7 +18792,7 @@ export type WebhookPayloadCommerceOrder = {
|
|
|
18638
18792
|
};
|
|
18639
18793
|
};
|
|
18640
18794
|
|
|
18641
|
-
export type
|
|
18795
|
+
export type event28 = 'commerce.order.created' | 'commerce.order.updated' | 'commerce.order.refunded';
|
|
18642
18796
|
|
|
18643
18797
|
export type type21 = 'order';
|
|
18644
18798
|
|
|
@@ -18681,7 +18835,7 @@ export type WebhookPayloadCommerceProduct = {
|
|
|
18681
18835
|
};
|
|
18682
18836
|
};
|
|
18683
18837
|
|
|
18684
|
-
export type
|
|
18838
|
+
export type event29 = 'commerce.product.created' | 'commerce.product.updated' | 'commerce.product.deleted';
|
|
18685
18839
|
|
|
18686
18840
|
export type type22 = 'product';
|
|
18687
18841
|
|
|
@@ -18710,7 +18864,7 @@ export type WebhookPayloadContact = {
|
|
|
18710
18864
|
timestamp: string;
|
|
18711
18865
|
};
|
|
18712
18866
|
|
|
18713
|
-
export type
|
|
18867
|
+
export type event30 = 'contact.updated' | 'contact.deleted';
|
|
18714
18868
|
|
|
18715
18869
|
export type changeType2 = 'updated' | 'deleted';
|
|
18716
18870
|
|
|
@@ -18750,7 +18904,7 @@ export type WebhookPayloadContactFieldChanged = {
|
|
|
18750
18904
|
source: 'api' | 'workflow' | 'automation';
|
|
18751
18905
|
};
|
|
18752
18906
|
|
|
18753
|
-
export type
|
|
18907
|
+
export type event31 = 'contact.field_changed';
|
|
18754
18908
|
|
|
18755
18909
|
/**
|
|
18756
18910
|
* Who wrote the field: the API or dashboard, a workflow set_field node, or an automation.
|
|
@@ -18782,7 +18936,7 @@ export type WebhookPayloadContactTag = {
|
|
|
18782
18936
|
source: 'api' | 'workflow' | 'automation';
|
|
18783
18937
|
};
|
|
18784
18938
|
|
|
18785
|
-
export type
|
|
18939
|
+
export type event32 = 'contact.tag_added' | 'contact.tag_removed';
|
|
18786
18940
|
|
|
18787
18941
|
/**
|
|
18788
18942
|
* Who answers a conversation changed under Meta's handover protocol. WhatsApp: Meta
|
|
@@ -18828,7 +18982,7 @@ export type WebhookPayloadConversationControlChanged = {
|
|
|
18828
18982
|
timestamp: string;
|
|
18829
18983
|
};
|
|
18830
18984
|
|
|
18831
|
-
export type
|
|
18985
|
+
export type event33 = 'conversation.control_changed';
|
|
18832
18986
|
|
|
18833
18987
|
/**
|
|
18834
18988
|
* 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 +19031,7 @@ export type WebhookPayloadConversationStarted = {
|
|
|
18877
19031
|
timestamp: string;
|
|
18878
19032
|
};
|
|
18879
19033
|
|
|
18880
|
-
export type
|
|
19034
|
+
export type event34 = 'conversation.started';
|
|
18881
19035
|
|
|
18882
19036
|
/**
|
|
18883
19037
|
* Webhook payload for `creator_campaign.budget_exhausted` and `creator_campaign.closed`.
|
|
@@ -18916,7 +19070,7 @@ export type WebhookPayloadCreatorCampaign = {
|
|
|
18916
19070
|
timestamp: string;
|
|
18917
19071
|
};
|
|
18918
19072
|
|
|
18919
|
-
export type
|
|
19073
|
+
export type event35 = 'creator_campaign.budget_exhausted' | 'creator_campaign.closed';
|
|
18920
19074
|
|
|
18921
19075
|
/**
|
|
18922
19076
|
* Webhook payload for post.external.created / post.external.updated /
|
|
@@ -18953,7 +19107,7 @@ export type WebhookPayloadExternalPost = {
|
|
|
18953
19107
|
timestamp: string;
|
|
18954
19108
|
};
|
|
18955
19109
|
|
|
18956
|
-
export type
|
|
19110
|
+
export type event36 = 'post.external.created' | 'post.external.updated' | 'post.external.deleted';
|
|
18957
19111
|
|
|
18958
19112
|
/**
|
|
18959
19113
|
* 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 +19134,7 @@ export type WebhookPayloadFile = {
|
|
|
18980
19134
|
timestamp: string;
|
|
18981
19135
|
};
|
|
18982
19136
|
|
|
18983
|
-
export type
|
|
19137
|
+
export type event37 = 'file.created' | 'file.updated' | 'file.deleted';
|
|
18984
19138
|
|
|
18985
19139
|
/**
|
|
18986
19140
|
* 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 +19169,7 @@ export type WebhookPayloadFilePicked = {
|
|
|
19015
19169
|
timestamp: string;
|
|
19016
19170
|
};
|
|
19017
19171
|
|
|
19018
|
-
export type
|
|
19172
|
+
export type event38 = 'file.picked';
|
|
19019
19173
|
|
|
19020
19174
|
/**
|
|
19021
19175
|
* Webhook payload for lead.received events (Meta Lead Gen / Instant Forms).
|
|
@@ -19095,7 +19249,7 @@ export type WebhookPayloadLead = {
|
|
|
19095
19249
|
timestamp: string;
|
|
19096
19250
|
};
|
|
19097
19251
|
|
|
19098
|
-
export type
|
|
19252
|
+
export type event39 = 'lead.received';
|
|
19099
19253
|
|
|
19100
19254
|
export type platform17 = 'facebook';
|
|
19101
19255
|
|
|
@@ -19675,7 +19829,7 @@ export type WebhookPayloadMessage = {
|
|
|
19675
19829
|
timestamp: string;
|
|
19676
19830
|
};
|
|
19677
19831
|
|
|
19678
|
-
export type
|
|
19832
|
+
export type event40 = 'message.received';
|
|
19679
19833
|
|
|
19680
19834
|
/**
|
|
19681
19835
|
* Which Zernio surface produced the message. Always present and
|
|
@@ -19734,7 +19888,7 @@ export type WebhookPayloadMessageDeleted = {
|
|
|
19734
19888
|
timestamp: string;
|
|
19735
19889
|
};
|
|
19736
19890
|
|
|
19737
|
-
export type
|
|
19891
|
+
export type event41 = 'message.deleted';
|
|
19738
19892
|
|
|
19739
19893
|
/**
|
|
19740
19894
|
* 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 +19952,7 @@ export type WebhookPayloadMessageDeliveryStatus = {
|
|
|
19798
19952
|
timestamp: string;
|
|
19799
19953
|
};
|
|
19800
19954
|
|
|
19801
|
-
export type
|
|
19955
|
+
export type event42 = 'message.delivered' | 'message.read' | 'message.played' | 'message.failed';
|
|
19802
19956
|
|
|
19803
19957
|
/**
|
|
19804
19958
|
* Webhook payload for message.edited events. Fires when the sender
|
|
@@ -19841,7 +19995,7 @@ export type WebhookPayloadMessageEdited = {
|
|
|
19841
19995
|
timestamp: string;
|
|
19842
19996
|
};
|
|
19843
19997
|
|
|
19844
|
-
export type
|
|
19998
|
+
export type event43 = 'message.edited';
|
|
19845
19999
|
|
|
19846
20000
|
/**
|
|
19847
20001
|
* 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 +20241,7 @@ export type WebhookPayloadMessageSent = {
|
|
|
20087
20241
|
timestamp: string;
|
|
20088
20242
|
};
|
|
20089
20243
|
|
|
20090
|
-
export type
|
|
20244
|
+
export type event44 = 'message.sent';
|
|
20091
20245
|
|
|
20092
20246
|
/**
|
|
20093
20247
|
* 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 +20306,7 @@ export type WebhookPayloadPhoneNumberStockAvailable = {
|
|
|
20152
20306
|
timestamp: string;
|
|
20153
20307
|
};
|
|
20154
20308
|
|
|
20155
|
-
export type
|
|
20309
|
+
export type event45 = 'phone_number.stock_available';
|
|
20156
20310
|
|
|
20157
20311
|
/**
|
|
20158
20312
|
* Webhook payload for post events
|
|
@@ -20207,7 +20361,7 @@ export type WebhookPayloadPost = {
|
|
|
20207
20361
|
timestamp: string;
|
|
20208
20362
|
};
|
|
20209
20363
|
|
|
20210
|
-
export type
|
|
20364
|
+
export type event46 = 'post.scheduled' | 'post.published' | 'post.failed' | 'post.partial' | 'post.cancelled' | 'post.recycled';
|
|
20211
20365
|
|
|
20212
20366
|
/**
|
|
20213
20367
|
* Webhook payload for `post.authenticity_changed`. Fired when a tracked post's
|
|
@@ -20271,7 +20425,7 @@ export type WebhookPayloadPostAuthenticityChanged = {
|
|
|
20271
20425
|
timestamp: string;
|
|
20272
20426
|
};
|
|
20273
20427
|
|
|
20274
|
-
export type
|
|
20428
|
+
export type event47 = 'post.authenticity_changed';
|
|
20275
20429
|
|
|
20276
20430
|
/**
|
|
20277
20431
|
* Webhook payload for these per-platform events:
|
|
@@ -20387,12 +20541,12 @@ export type WebhookPayloadPostPlatform = {
|
|
|
20387
20541
|
timestamp: string;
|
|
20388
20542
|
};
|
|
20389
20543
|
|
|
20390
|
-
export type
|
|
20544
|
+
export type event48 = 'post.platform.published' | 'post.platform.failed' | 'post.platform.deleted' | 'post.tiktok.url_resolved';
|
|
20391
20545
|
|
|
20392
20546
|
/**
|
|
20393
20547
|
* Terminal status this event fires on. Matches the event suffix.
|
|
20394
20548
|
*/
|
|
20395
|
-
export type
|
|
20549
|
+
export type status55 = 'published' | 'failed' | 'deleted';
|
|
20396
20550
|
|
|
20397
20551
|
/**
|
|
20398
20552
|
* Webhook payload for `post.tracking_completed`. Fired once when a post's tracking window ends and its final analytics read has run.
|
|
@@ -20460,7 +20614,7 @@ export type WebhookPayloadPostTrackingCompleted = {
|
|
|
20460
20614
|
timestamp: string;
|
|
20461
20615
|
};
|
|
20462
20616
|
|
|
20463
|
-
export type
|
|
20617
|
+
export type event49 = 'post.tracking_completed';
|
|
20464
20618
|
|
|
20465
20619
|
export type completionReason2 = 'final_read' | 'unreachable' | 'post_deleted';
|
|
20466
20620
|
|
|
@@ -20522,7 +20676,7 @@ export type WebhookPayloadReaction = {
|
|
|
20522
20676
|
timestamp: string;
|
|
20523
20677
|
};
|
|
20524
20678
|
|
|
20525
|
-
export type
|
|
20679
|
+
export type event50 = 'reaction.received';
|
|
20526
20680
|
|
|
20527
20681
|
export type action = 'added' | 'removed';
|
|
20528
20682
|
|
|
@@ -20601,7 +20755,7 @@ export type WebhookPayloadReferral = {
|
|
|
20601
20755
|
timestamp: string;
|
|
20602
20756
|
};
|
|
20603
20757
|
|
|
20604
|
-
export type
|
|
20758
|
+
export type event51 = 'referral.received';
|
|
20605
20759
|
|
|
20606
20760
|
/**
|
|
20607
20761
|
* Webhook payload for the review.deleted event.
|
|
@@ -20659,7 +20813,7 @@ export type WebhookPayloadReviewDeleted = {
|
|
|
20659
20813
|
timestamp: string;
|
|
20660
20814
|
};
|
|
20661
20815
|
|
|
20662
|
-
export type
|
|
20816
|
+
export type event52 = 'review.deleted';
|
|
20663
20817
|
|
|
20664
20818
|
/**
|
|
20665
20819
|
* Webhook payload for the review.new event (new review posted on a connected account).
|
|
@@ -20691,7 +20845,7 @@ export type WebhookPayloadReviewNew = {
|
|
|
20691
20845
|
timestamp: string;
|
|
20692
20846
|
};
|
|
20693
20847
|
|
|
20694
|
-
export type
|
|
20848
|
+
export type event53 = 'review.new';
|
|
20695
20849
|
|
|
20696
20850
|
/**
|
|
20697
20851
|
* Webhook payload for the review.restored event. Same shape as review.new.
|
|
@@ -20726,7 +20880,7 @@ export type WebhookPayloadReviewRestored = {
|
|
|
20726
20880
|
timestamp: string;
|
|
20727
20881
|
};
|
|
20728
20882
|
|
|
20729
|
-
export type
|
|
20883
|
+
export type event54 = 'review.restored';
|
|
20730
20884
|
|
|
20731
20885
|
/**
|
|
20732
20886
|
* Webhook payload for the review.updated event. Same shape as review.new.
|
|
@@ -20774,7 +20928,7 @@ export type WebhookPayloadReviewUpdated = {
|
|
|
20774
20928
|
timestamp: string;
|
|
20775
20929
|
};
|
|
20776
20930
|
|
|
20777
|
-
export type
|
|
20931
|
+
export type event55 = 'review.updated';
|
|
20778
20932
|
|
|
20779
20933
|
export type WebhookPayloadSequenceEnrollment = {
|
|
20780
20934
|
/**
|
|
@@ -20807,7 +20961,7 @@ export type WebhookPayloadSequenceEnrollment = {
|
|
|
20807
20961
|
exitReason?: 'completed' | 'replied' | 'manual' | 'failed' | 'unsubscribed';
|
|
20808
20962
|
};
|
|
20809
20963
|
|
|
20810
|
-
export type
|
|
20964
|
+
export type event56 = 'sequence.enrolled' | 'sequence.exited';
|
|
20811
20965
|
|
|
20812
20966
|
/**
|
|
20813
20967
|
* 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 +20982,7 @@ export type WebhookPayloadSupportRun = {
|
|
|
20828
20982
|
run: SupportRun;
|
|
20829
20983
|
};
|
|
20830
20984
|
|
|
20831
|
-
export type
|
|
20985
|
+
export type event57 = 'support.run.completed' | 'support.run.failed';
|
|
20832
20986
|
|
|
20833
20987
|
/**
|
|
20834
20988
|
* Webhook payload for test deliveries
|
|
@@ -20849,7 +21003,7 @@ export type WebhookPayloadTest = {
|
|
|
20849
21003
|
timestamp: string;
|
|
20850
21004
|
};
|
|
20851
21005
|
|
|
20852
|
-
export type
|
|
21006
|
+
export type event58 = 'webhook.test';
|
|
20853
21007
|
|
|
20854
21008
|
/**
|
|
20855
21009
|
* Webhook payload for `whatsapp.account.alert_received`, forwarded from Meta's
|
|
@@ -20901,7 +21055,7 @@ export type WebhookPayloadWhatsAppAccountAlertReceived = {
|
|
|
20901
21055
|
timestamp: string;
|
|
20902
21056
|
};
|
|
20903
21057
|
|
|
20904
|
-
export type
|
|
21058
|
+
export type event59 = 'whatsapp.account.alert_received';
|
|
20905
21059
|
|
|
20906
21060
|
export type platform19 = 'whatsapp';
|
|
20907
21061
|
|
|
@@ -20953,12 +21107,12 @@ export type WebhookPayloadWhatsAppAccountNameStatusUpdated = {
|
|
|
20953
21107
|
timestamp: string;
|
|
20954
21108
|
};
|
|
20955
21109
|
|
|
20956
|
-
export type
|
|
21110
|
+
export type event60 = 'whatsapp.account.name_status_updated';
|
|
20957
21111
|
|
|
20958
21112
|
/**
|
|
20959
21113
|
* Normalized from Meta's `decision` (REJECTED -> DECLINED, DEFERRED -> PENDING_REVIEW; the review is still open on DEFERRED, not a rejection).
|
|
20960
21114
|
*/
|
|
20961
|
-
export type
|
|
21115
|
+
export type status56 = 'APPROVED' | 'DECLINED' | 'PENDING_REVIEW';
|
|
20962
21116
|
|
|
20963
21117
|
/**
|
|
20964
21118
|
* Webhook payload for `whatsapp.account.quality_updated`. Fired when a connected
|
|
@@ -21011,7 +21165,7 @@ export type WebhookPayloadWhatsAppAccountQualityUpdated = {
|
|
|
21011
21165
|
timestamp: string;
|
|
21012
21166
|
};
|
|
21013
21167
|
|
|
21014
|
-
export type
|
|
21168
|
+
export type event61 = 'whatsapp.account.quality_updated';
|
|
21015
21169
|
|
|
21016
21170
|
/**
|
|
21017
21171
|
* The Meta webhook field that reported the change.
|
|
@@ -21087,12 +21241,12 @@ export type WebhookPayloadWhatsAppAccountStatusUpdated = {
|
|
|
21087
21241
|
timestamp: string;
|
|
21088
21242
|
};
|
|
21089
21243
|
|
|
21090
|
-
export type
|
|
21244
|
+
export type event62 = 'whatsapp.account.status_updated';
|
|
21091
21245
|
|
|
21092
21246
|
/**
|
|
21093
21247
|
* `active` only on a reinstatement (DISABLED_UPDATE with ban state REINSTATE).
|
|
21094
21248
|
*/
|
|
21095
|
-
export type
|
|
21249
|
+
export type status57 = 'restricted' | 'active';
|
|
21096
21250
|
|
|
21097
21251
|
/**
|
|
21098
21252
|
* Webhook payload for the `whatsapp.contact.identity_changed` event. Fired when
|
|
@@ -21144,7 +21298,7 @@ export type WebhookPayloadWhatsAppContactIdentityChanged = {
|
|
|
21144
21298
|
timestamp: string;
|
|
21145
21299
|
};
|
|
21146
21300
|
|
|
21147
|
-
export type
|
|
21301
|
+
export type event63 = 'whatsapp.contact.identity_changed';
|
|
21148
21302
|
|
|
21149
21303
|
/**
|
|
21150
21304
|
* Which Meta signal reported the change. `user_changed_number`: new phone number. `user_changed_user_id` and `user_id_update`: new BSUID.
|
|
@@ -21218,7 +21372,7 @@ export type WebhookPayloadWhatsAppTemplateCategoryUpdated = {
|
|
|
21218
21372
|
timestamp: string;
|
|
21219
21373
|
};
|
|
21220
21374
|
|
|
21221
|
-
export type
|
|
21375
|
+
export type event64 = 'whatsapp.template.category_updated';
|
|
21222
21376
|
|
|
21223
21377
|
/**
|
|
21224
21378
|
* `scheduled` is Meta's 24h advance notice of an upcoming
|
|
@@ -21300,7 +21454,7 @@ export type WebhookPayloadWhatsAppTemplateStatusUpdated = {
|
|
|
21300
21454
|
timestamp: string;
|
|
21301
21455
|
};
|
|
21302
21456
|
|
|
21303
|
-
export type
|
|
21457
|
+
export type event65 = 'whatsapp.template.status_updated';
|
|
21304
21458
|
|
|
21305
21459
|
/**
|
|
21306
21460
|
* New status. Forwarded verbatim from Meta's `event` field.
|
|
@@ -21308,7 +21462,7 @@ export type event63 = 'whatsapp.template.status_updated';
|
|
|
21308
21462
|
* request before the template is actually removed.
|
|
21309
21463
|
*
|
|
21310
21464
|
*/
|
|
21311
|
-
export type
|
|
21465
|
+
export type status58 = 'APPROVED' | 'REJECTED' | 'PENDING' | 'PAUSED' | 'DISABLED' | 'IN_APPEAL' | 'PENDING_DELETION';
|
|
21312
21466
|
|
|
21313
21467
|
export type WebhookPayloadWorkflowRun = {
|
|
21314
21468
|
/**
|
|
@@ -21367,12 +21521,12 @@ export type WebhookPayloadWorkflowRun = {
|
|
|
21367
21521
|
error?: string;
|
|
21368
21522
|
};
|
|
21369
21523
|
|
|
21370
|
-
export type
|
|
21524
|
+
export type event66 = 'workflow.run.started' | 'workflow.run.completed' | 'workflow.run.failed';
|
|
21371
21525
|
|
|
21372
21526
|
/**
|
|
21373
21527
|
* 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
21528
|
*/
|
|
21375
|
-
export type
|
|
21529
|
+
export type status59 = 'running' | 'waiting' | 'completed' | 'exited' | 'failed';
|
|
21376
21530
|
|
|
21377
21531
|
/**
|
|
21378
21532
|
* 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 +21926,7 @@ export type WorkflowExecutionEvent = {
|
|
|
21772
21926
|
|
|
21773
21927
|
export type action2 = 'execution_started' | 'execution_completed' | 'execution_exited' | 'execution_paused' | 'execution_resumed' | 'node_started' | 'node_completed' | 'node_failed' | 'node_skipped';
|
|
21774
21928
|
|
|
21775
|
-
export type
|
|
21929
|
+
export type status60 = 'success' | 'failed' | 'pending';
|
|
21776
21930
|
|
|
21777
21931
|
/**
|
|
21778
21932
|
* A node in a workflow graph. `config` shape depends on `type`.
|
|
@@ -35501,7 +35655,7 @@ export type CreateWebhookSettingsData = {
|
|
|
35501
35655
|
/**
|
|
35502
35656
|
* Events to subscribe to (at least one required)
|
|
35503
35657
|
*/
|
|
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')>;
|
|
35658
|
+
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
35659
|
/**
|
|
35506
35660
|
* Enable or disable webhook delivery. Defaults to `true` when omitted.
|
|
35507
35661
|
*/
|
|
@@ -35573,7 +35727,7 @@ export type UpdateWebhookSettingsData = {
|
|
|
35573
35727
|
/**
|
|
35574
35728
|
* Events to subscribe to. Must contain at least one event if provided.
|
|
35575
35729
|
*/
|
|
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')>;
|
|
35730
|
+
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
35731
|
/**
|
|
35578
35732
|
* Enable or disable webhook delivery
|
|
35579
35733
|
*/
|
|
@@ -35762,7 +35916,7 @@ export type TestWebhookData = {
|
|
|
35762
35916
|
/**
|
|
35763
35917
|
* Send a sample payload of this event instead of `webhook.test`. The sample is marked with `test: true`.
|
|
35764
35918
|
*/
|
|
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';
|
|
35919
|
+
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
35920
|
};
|
|
35767
35921
|
};
|
|
35768
35922
|
|