@messagebird/n8n-nodes-bird 0.31.0 → 0.32.0
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.
|
@@ -652,6 +652,13 @@ exports.birdProperties = [
|
|
|
652
652
|
},
|
|
653
653
|
],
|
|
654
654
|
},
|
|
655
|
+
{
|
|
656
|
+
displayName: "Reference",
|
|
657
|
+
name: "reference",
|
|
658
|
+
type: "string",
|
|
659
|
+
default: "",
|
|
660
|
+
description: "An identifier you want to find this message by, such as an order or ticket number, matched exactly by the message list's `reference` filter. Set it only when you need to search on it, and put any other data in `metadata`. Stored on the message, returned on reads and echoed in webhook payloads. Several messages can share one.",
|
|
661
|
+
},
|
|
655
662
|
{
|
|
656
663
|
displayName: "Reply To",
|
|
657
664
|
name: "reply_to",
|
|
@@ -884,6 +891,13 @@ exports.birdProperties = [
|
|
|
884
891
|
default: "",
|
|
885
892
|
description: "Filter by sender address. Exact match against the message `from` field. The address is normalized to lowercase before comparison.",
|
|
886
893
|
},
|
|
894
|
+
{
|
|
895
|
+
displayName: "Reference",
|
|
896
|
+
name: "reference",
|
|
897
|
+
type: "string",
|
|
898
|
+
default: "",
|
|
899
|
+
description: "Keep only messages whose `reference` is exactly this value. The match is case-sensitive, and several messages can share a reference.",
|
|
900
|
+
},
|
|
887
901
|
{
|
|
888
902
|
displayName: "Status",
|
|
889
903
|
name: "status",
|
|
@@ -2788,6 +2802,30 @@ exports.birdProperties = [
|
|
|
2788
2802
|
default: {},
|
|
2789
2803
|
displayOptions: { show: { resource: ["sms"], operation: ["send"] } },
|
|
2790
2804
|
options: [
|
|
2805
|
+
{
|
|
2806
|
+
displayName: "Binary",
|
|
2807
|
+
name: "binary",
|
|
2808
|
+
type: "collection",
|
|
2809
|
+
placeholder: "Add Field",
|
|
2810
|
+
default: {},
|
|
2811
|
+
description: "Send an 8-bit binary payload instead of `text` or `template`. Requires `category` `transactional` and refuses `options.smart_encoding`. It is sent and charged as one segment.",
|
|
2812
|
+
options: [
|
|
2813
|
+
{
|
|
2814
|
+
displayName: "Udh",
|
|
2815
|
+
name: "udh",
|
|
2816
|
+
type: "string",
|
|
2817
|
+
default: "",
|
|
2818
|
+
description: "User data header as hexadecimal, 1-16 octets. Required on a send: a binary send without it returns `422`. Its first octet must count the octets after it, every information element must fit inside it, and concatenation elements (`00`, `08`) are refused because the message is one segment.",
|
|
2819
|
+
},
|
|
2820
|
+
{
|
|
2821
|
+
displayName: "Data",
|
|
2822
|
+
name: "data",
|
|
2823
|
+
type: "string",
|
|
2824
|
+
default: "",
|
|
2825
|
+
description: "The payload after the header, as hexadecimal",
|
|
2826
|
+
},
|
|
2827
|
+
],
|
|
2828
|
+
},
|
|
2791
2829
|
{
|
|
2792
2830
|
displayName: "Category",
|
|
2793
2831
|
name: "category",
|
|
@@ -2802,6 +2840,13 @@ exports.birdProperties = [
|
|
|
2802
2840
|
default: "",
|
|
2803
2841
|
description: "Content classification: why you are sending. Required on a free-text send unless the messaging profile in `messaging_profile_id` sets a default category; omit it on a template send, where the category is derived from the template. Where the destination country requires the sender to be registered, a category outside what that registration covers returns a `422` `SenderCategoryNotPermitted`.",
|
|
2804
2842
|
},
|
|
2843
|
+
{
|
|
2844
|
+
displayName: "Cost Center",
|
|
2845
|
+
name: "cost_center",
|
|
2846
|
+
type: "string",
|
|
2847
|
+
default: "",
|
|
2848
|
+
description: "Your accounting identifier for this message, such as a department code. Stored on the message and its usage record, returned on reads, and echoed in webhook payloads. Omit it to use the cost center of the messaging profile in `messaging_profile_id`. Accepting it does not change how the message is priced.",
|
|
2849
|
+
},
|
|
2805
2850
|
{
|
|
2806
2851
|
displayName: "From",
|
|
2807
2852
|
name: "from",
|
|
@@ -2809,6 +2854,13 @@ exports.birdProperties = [
|
|
|
2809
2854
|
default: "",
|
|
2810
2855
|
description: "Sender to send from. It must be a sender the workspace holds: a number it owns in E.164, such as `+15557654321`, a short code it holds, such as `24680`, or an alphanumeric sender ID it has claimed, such as `MyBrand`. A sender the workspace does not hold returns a `422` `SMSSenderNotConfigured`, and an alphanumeric sender must also be permitted, and where required registered, for the destination country. Required on a free-text send and when sending a workspace template, unless `messaging_profile_id` is set and the profile selects a sender for the destination country or has a default sender. Omitting it otherwise returns `422`. A built-in template selects its sender automatically and rejects `from`.",
|
|
2811
2856
|
},
|
|
2857
|
+
{
|
|
2858
|
+
displayName: "Messaging Profile ID",
|
|
2859
|
+
name: "messaging_profile_id",
|
|
2860
|
+
type: "string",
|
|
2861
|
+
default: "",
|
|
2862
|
+
description: "The messaging profile that supplies this message's sender and defaults. When `from` is omitted, Bird sends from the profile's sender for the destination country, or its default sender. An omitted `category` on a free-text send takes the profile's default category, and `smart_encoding`, `cost_center` and `validity_period` take the profile's settings. So do `options.callback_url` and `options.ignore_suppression`, which apply to the message. Values you set on the message take precedence. A built-in template sends from Bird's system sender and ignores the profile's senders. A profile that does not exist in this workspace returns `422` `SMSMessagingProfileNotFound`; a `from` bound to a different profile returns `422` `SMSMessagingProfileSenderBound`.",
|
|
2863
|
+
},
|
|
2812
2864
|
{
|
|
2813
2865
|
displayName: "Metadata",
|
|
2814
2866
|
name: "metadata",
|
|
@@ -2853,8 +2905,29 @@ exports.birdProperties = [
|
|
|
2853
2905
|
default: false,
|
|
2854
2906
|
description: "Whether to replace characters outside the GSM-7 alphabet with their closest GSM-7 equivalent before sending: typically curly quotes, dashes, ellipses, fullwidth forms, and non-breaking spaces. One such character forces the whole body into `UCS2`, which more than halves the characters that fit in a segment, so replacing them often lowers the segment count and the cost. Disabled by default, because it alters the body you composed. The replacement is all-or-nothing: a body that still holds a character outside the alphabet afterwards, such as an emoji or a non-Latin script, is sent exactly as you supplied it. Read the message back to see what was applied: `text` is the body as sent.",
|
|
2855
2907
|
},
|
|
2908
|
+
{
|
|
2909
|
+
displayName: "Ignore Suppression",
|
|
2910
|
+
name: "ignore_suppression",
|
|
2911
|
+
type: "boolean",
|
|
2912
|
+
default: false,
|
|
2913
|
+
description: "Whether to send this message even if the recipient is suppressed for the sender, including after replying STOP. Bird skips every suppression reason and records the flag on the message; communication preferences the recipient revoked still apply. Only `authentication` and `transactional` messages can use it; setting it to `true` on a `marketing` or `service` message returns `422`. Bird must enable it for your workspace first; until then, a message that uses it is refused with `422`. Omit it to use the setting of the messaging profile in `messaging_profile_id`.",
|
|
2914
|
+
},
|
|
2915
|
+
{
|
|
2916
|
+
displayName: "Callback URL",
|
|
2917
|
+
name: "callback_url",
|
|
2918
|
+
type: "string",
|
|
2919
|
+
default: "",
|
|
2920
|
+
description: "An HTTPS URL that receives this message's events instead of your webhook endpoints. It must be a public address: a private, loopback or link-local host returns `422`. Bird fixes the URL when it accepts the message, so later profile changes do not reroute it. Each event is a signed POST, retried on failure, and signed with your workspace callback signing secret, which `rotateWebhookCallbackSigningSecret` creates and returns once. While a URL applies, this message's events skip your plain webhook endpoints, and a failed callback never falls back to them. MCP Events subscriptions and connector endpoints still receive them. The `callback_events` of the messaging profile in `messaging_profile_id` choose which events go to the URL. Omit the field to use the callback URL of that profile; send `null` to send this message's events to your webhook subscriptions.",
|
|
2921
|
+
},
|
|
2856
2922
|
],
|
|
2857
2923
|
},
|
|
2924
|
+
{
|
|
2925
|
+
displayName: "Reference",
|
|
2926
|
+
name: "reference",
|
|
2927
|
+
type: "string",
|
|
2928
|
+
default: "",
|
|
2929
|
+
description: "An identifier you want to find this message by, such as an order or ticket number, matched exactly by the message list's `reference` filter. Set it only when you need to search on it, and put any other data in `metadata`. Stored on the message, returned on reads and echoed in webhook payloads. Several messages can share one.",
|
|
2930
|
+
},
|
|
2858
2931
|
{
|
|
2859
2932
|
displayName: "Tags",
|
|
2860
2933
|
name: "tags",
|
|
@@ -2960,6 +3033,20 @@ exports.birdProperties = [
|
|
|
2960
3033
|
default: "",
|
|
2961
3034
|
description: "Free-text message body. Required unless `template` is supplied (the two are mutually exclusive). At least 1 character, up to a 12-segment cap (roughly 1836 GSM-7 or 804 UCS-2 characters). Bird does not truncate; a body exceeding 12 segments is rejected with a 422. The cap applies to segments because GSM-7 and UCS-2 encodings differ in characters per segment.",
|
|
2962
3035
|
},
|
|
3036
|
+
{
|
|
3037
|
+
displayName: "To Country Code",
|
|
3038
|
+
name: "to_country_code",
|
|
3039
|
+
type: "string",
|
|
3040
|
+
default: "",
|
|
3041
|
+
description: "The ISO 3166-1 alpha-2 country whose national numbering plan `to` is written in, such as `NL` for `0612345678`. Bird converts `to` to E.164 before checking the destination, price and sender. An E.164 `to` is still accepted when its country calling code matches this country; a mismatch, or a national number that is not valid in this country, returns a `422` `SMSInvalidRecipient`. Omit it to send `to` in E.164.",
|
|
3042
|
+
},
|
|
3043
|
+
{
|
|
3044
|
+
displayName: "Validity Period",
|
|
3045
|
+
name: "validity_period",
|
|
3046
|
+
type: "number",
|
|
3047
|
+
default: "",
|
|
3048
|
+
description: "How long, in seconds (60-172800), the message may wait for delivery, counted from acceptance. Bird does not submit the message to the carrier after this deadline and passes the remaining time to the carrier where the route supports it. A message that misses the deadline before reaching the carrier ends `rejected` or `failed`, not `expired`; `expired` comes only from a carrier report. Omit it to use the validity period of the messaging profile in `messaging_profile_id`, or the carrier's own validity rules when the profile sets none.",
|
|
3049
|
+
},
|
|
2963
3050
|
],
|
|
2964
3051
|
},
|
|
2965
3052
|
{
|
|
@@ -3080,6 +3167,13 @@ exports.birdProperties = [
|
|
|
3080
3167
|
default: "",
|
|
3081
3168
|
description: "Filter by sender (E.164, alphanumeric, or short code; exact match)",
|
|
3082
3169
|
},
|
|
3170
|
+
{
|
|
3171
|
+
displayName: "Reference",
|
|
3172
|
+
name: "reference",
|
|
3173
|
+
type: "string",
|
|
3174
|
+
default: "",
|
|
3175
|
+
description: "Keep only messages whose `reference` is exactly this value. The match is case-sensitive, and several messages can share a reference.",
|
|
3176
|
+
},
|
|
3083
3177
|
{
|
|
3084
3178
|
displayName: "Status",
|
|
3085
3179
|
name: "status",
|
|
@@ -3286,14 +3380,14 @@ exports.birdProperties = [
|
|
|
3286
3380
|
name: "carrier",
|
|
3287
3381
|
type: "string",
|
|
3288
3382
|
default: "",
|
|
3289
|
-
description: "Restrict the statistics to a single delivery carrier. Mutually exclusive with the other dimension filters
|
|
3383
|
+
description: "Restrict the statistics to a single delivery carrier. Mutually exclusive with the other dimension filters; only one may be set per request.",
|
|
3290
3384
|
},
|
|
3291
3385
|
{
|
|
3292
3386
|
displayName: "Category",
|
|
3293
3387
|
name: "category",
|
|
3294
3388
|
type: "string",
|
|
3295
3389
|
default: "",
|
|
3296
|
-
description: "Restrict the statistics to a single category. Mutually exclusive with the other dimension filters
|
|
3390
|
+
description: "Restrict the statistics to a single category. Mutually exclusive with the other dimension filters; only one may be set per request.",
|
|
3297
3391
|
},
|
|
3298
3392
|
{
|
|
3299
3393
|
displayName: "Compare",
|
|
@@ -3311,7 +3405,7 @@ exports.birdProperties = [
|
|
|
3311
3405
|
name: "country",
|
|
3312
3406
|
type: "string",
|
|
3313
3407
|
default: "",
|
|
3314
|
-
description: "Restrict the statistics to a single destination country, as an ISO 3166-1 alpha-2 code. Mutually exclusive with the other dimension filters
|
|
3408
|
+
description: "Restrict the statistics to a single destination country, as an ISO 3166-1 alpha-2 code. Mutually exclusive with the other dimension filters; only one may be set per request.",
|
|
3315
3409
|
},
|
|
3316
3410
|
{
|
|
3317
3411
|
displayName: "From",
|
|
@@ -3325,7 +3419,7 @@ exports.birdProperties = [
|
|
|
3325
3419
|
name: "originator",
|
|
3326
3420
|
type: "string",
|
|
3327
3421
|
default: "",
|
|
3328
|
-
description: "Restrict the statistics to a single originator (the sender address messages were sent from). Mutually exclusive with the other dimension filters
|
|
3422
|
+
description: "Restrict the statistics to a single originator (the sender address messages were sent from). Mutually exclusive with the other dimension filters; only one may be set per request. Matches the message `from`.",
|
|
3329
3423
|
},
|
|
3330
3424
|
{
|
|
3331
3425
|
displayName: "Timezone",
|
|
@@ -3356,21 +3450,21 @@ exports.birdProperties = [
|
|
|
3356
3450
|
name: "carrier",
|
|
3357
3451
|
type: "string",
|
|
3358
3452
|
default: "",
|
|
3359
|
-
description: "Restrict the statistics to a single delivery carrier. Mutually exclusive with the other dimension filters
|
|
3453
|
+
description: "Restrict the statistics to a single delivery carrier. Mutually exclusive with the other dimension filters; only one may be set per request.",
|
|
3360
3454
|
},
|
|
3361
3455
|
{
|
|
3362
3456
|
displayName: "Category",
|
|
3363
3457
|
name: "category",
|
|
3364
3458
|
type: "string",
|
|
3365
3459
|
default: "",
|
|
3366
|
-
description: "Restrict the statistics to a single category. Mutually exclusive with the other dimension filters
|
|
3460
|
+
description: "Restrict the statistics to a single category. Mutually exclusive with the other dimension filters; only one may be set per request.",
|
|
3367
3461
|
},
|
|
3368
3462
|
{
|
|
3369
3463
|
displayName: "Country",
|
|
3370
3464
|
name: "country",
|
|
3371
3465
|
type: "string",
|
|
3372
3466
|
default: "",
|
|
3373
|
-
description: "Restrict the statistics to a single destination country, as an ISO 3166-1 alpha-2 code. Mutually exclusive with the other dimension filters
|
|
3467
|
+
description: "Restrict the statistics to a single destination country, as an ISO 3166-1 alpha-2 code. Mutually exclusive with the other dimension filters; only one may be set per request.",
|
|
3374
3468
|
},
|
|
3375
3469
|
{
|
|
3376
3470
|
displayName: "From",
|
|
@@ -3384,7 +3478,7 @@ exports.birdProperties = [
|
|
|
3384
3478
|
name: "originator",
|
|
3385
3479
|
type: "string",
|
|
3386
3480
|
default: "",
|
|
3387
|
-
description: "Restrict the statistics to a single originator (the sender address messages were sent from). Mutually exclusive with the other dimension filters
|
|
3481
|
+
description: "Restrict the statistics to a single originator (the sender address messages were sent from). Mutually exclusive with the other dimension filters; only one may be set per request. Matches the message `from`.",
|
|
3388
3482
|
},
|
|
3389
3483
|
{
|
|
3390
3484
|
displayName: "Timezone",
|
|
@@ -3415,21 +3509,21 @@ exports.birdProperties = [
|
|
|
3415
3509
|
name: "carrier",
|
|
3416
3510
|
type: "string",
|
|
3417
3511
|
default: "",
|
|
3418
|
-
description: "Restrict the statistics to a single delivery carrier. Mutually exclusive with the other dimension filters
|
|
3512
|
+
description: "Restrict the statistics to a single delivery carrier. Mutually exclusive with the other dimension filters; only one may be set per request.",
|
|
3419
3513
|
},
|
|
3420
3514
|
{
|
|
3421
3515
|
displayName: "Category",
|
|
3422
3516
|
name: "category",
|
|
3423
3517
|
type: "string",
|
|
3424
3518
|
default: "",
|
|
3425
|
-
description: "Restrict the statistics to a single category. Mutually exclusive with the other dimension filters
|
|
3519
|
+
description: "Restrict the statistics to a single category. Mutually exclusive with the other dimension filters; only one may be set per request.",
|
|
3426
3520
|
},
|
|
3427
3521
|
{
|
|
3428
3522
|
displayName: "Country",
|
|
3429
3523
|
name: "country",
|
|
3430
3524
|
type: "string",
|
|
3431
3525
|
default: "",
|
|
3432
|
-
description: "Restrict the statistics to a single destination country, as an ISO 3166-1 alpha-2 code. Mutually exclusive with the other dimension filters
|
|
3526
|
+
description: "Restrict the statistics to a single destination country, as an ISO 3166-1 alpha-2 code. Mutually exclusive with the other dimension filters; only one may be set per request.",
|
|
3433
3527
|
},
|
|
3434
3528
|
{
|
|
3435
3529
|
displayName: "From",
|
|
@@ -3443,7 +3537,7 @@ exports.birdProperties = [
|
|
|
3443
3537
|
name: "originator",
|
|
3444
3538
|
type: "string",
|
|
3445
3539
|
default: "",
|
|
3446
|
-
description: "Restrict the statistics to a single originator (the sender address messages were sent from). Mutually exclusive with the other dimension filters
|
|
3540
|
+
description: "Restrict the statistics to a single originator (the sender address messages were sent from). Mutually exclusive with the other dimension filters; only one may be set per request. Matches the message `from`.",
|
|
3447
3541
|
},
|
|
3448
3542
|
{
|
|
3449
3543
|
displayName: "Timezone",
|
|
@@ -4830,6 +4924,13 @@ exports.birdProperties = [
|
|
|
4830
4924
|
},
|
|
4831
4925
|
],
|
|
4832
4926
|
},
|
|
4927
|
+
{
|
|
4928
|
+
displayName: "Reference",
|
|
4929
|
+
name: "reference",
|
|
4930
|
+
type: "string",
|
|
4931
|
+
default: "",
|
|
4932
|
+
description: "An identifier you want to find this message by, such as an order or ticket number, matched exactly by the message list's `reference` filter. Set it only when you need to search on it, and put any other data in `metadata`. Stored on the message, returned on reads and echoed in webhook payloads. Several messages can share one.",
|
|
4933
|
+
},
|
|
4833
4934
|
{
|
|
4834
4935
|
displayName: "Sticker",
|
|
4835
4936
|
name: "sticker",
|
|
@@ -5088,6 +5189,13 @@ exports.birdProperties = [
|
|
|
5088
5189
|
default: "",
|
|
5089
5190
|
description: "Deprecated: use `to` or `from` instead, which also match a business-scoped user ID. Filters by contact phone number (E.164 exact match), in either direction.",
|
|
5090
5191
|
},
|
|
5192
|
+
{
|
|
5193
|
+
displayName: "Reference",
|
|
5194
|
+
name: "reference",
|
|
5195
|
+
type: "string",
|
|
5196
|
+
default: "",
|
|
5197
|
+
description: "Keep only messages whose `reference` is exactly this value. The match is case-sensitive, and several messages can share a reference.",
|
|
5198
|
+
},
|
|
5091
5199
|
{
|
|
5092
5200
|
displayName: "Status",
|
|
5093
5201
|
name: "status",
|
|
@@ -6984,6 +7092,23 @@ exports.birdProperties = [
|
|
|
6984
7092
|
],
|
|
6985
7093
|
description: "ID of the webhook endpoint (`whk_` prefix), as returned when it was created",
|
|
6986
7094
|
},
|
|
7095
|
+
{
|
|
7096
|
+
displayName: "Return All",
|
|
7097
|
+
name: "returnAll",
|
|
7098
|
+
type: "boolean",
|
|
7099
|
+
displayOptions: { show: { resource: ["webhooks"], operation: ["attempts"] } },
|
|
7100
|
+
default: false,
|
|
7101
|
+
description: "Whether to return all results or only up to a given limit",
|
|
7102
|
+
},
|
|
7103
|
+
{
|
|
7104
|
+
displayName: "Limit",
|
|
7105
|
+
name: "limit",
|
|
7106
|
+
type: "number",
|
|
7107
|
+
typeOptions: { minValue: 1 },
|
|
7108
|
+
displayOptions: { show: { resource: ["webhooks"], operation: ["attempts"] } },
|
|
7109
|
+
default: 50,
|
|
7110
|
+
description: "Max number of results to return",
|
|
7111
|
+
},
|
|
6987
7112
|
{
|
|
6988
7113
|
displayName: "Additional Fields",
|
|
6989
7114
|
name: "additionalFields",
|
|
@@ -2,10 +2,10 @@
|
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
3
|
exports.birdRoutes = void 0;
|
|
4
4
|
exports.birdRoutes = {
|
|
5
|
-
"email:send": { method: "POST", path: "/v1/email/messages", pathParams: [], topLevel: ["from", "to"], collections: ["additionalFields"], query: [], body: ["from", "to", "cc", "bcc", "subject", "html", "text", "reply_to", "headers", "tags", "metadata", "parameters", "template", "track_opens", "track_clicks", "ip_pool_id", "category", "attachments", "scheduled_at"], jsonFields: [], structured: { "headers": "map", "tags": "list", "metadata": "map", "parameters": "map", "template": "struct", "attachments": "list" }, preserveEmptyFields: ["parameters"], renames: {}, arrayFields: ["to", "cc", "bcc", "reply_to"], dateTimeFields: ["scheduled_at"], nullableFields: [], binaryFields: ["attachments"], rawBodyField: "", paginated: false, collection: false, idempotencyHeader: true, scopes: ["emails"] },
|
|
5
|
+
"email:send": { method: "POST", path: "/v1/email/messages", pathParams: [], topLevel: ["from", "to"], collections: ["additionalFields"], query: [], body: ["from", "to", "cc", "bcc", "subject", "html", "text", "reply_to", "headers", "tags", "metadata", "reference", "parameters", "template", "track_opens", "track_clicks", "ip_pool_id", "category", "attachments", "scheduled_at"], jsonFields: [], structured: { "headers": "map", "tags": "list", "metadata": "map", "parameters": "map", "template": "struct", "attachments": "list" }, preserveEmptyFields: ["parameters"], renames: {}, arrayFields: ["to", "cc", "bcc", "reply_to"], dateTimeFields: ["scheduled_at"], nullableFields: [], binaryFields: ["attachments"], rawBodyField: "", paginated: false, collection: false, idempotencyHeader: true, scopes: ["emails"] },
|
|
6
6
|
"email:send_batch": { method: "POST", path: "/v1/email/batches", pathParams: [], topLevel: ["messages"], collections: ["additionalFields"], query: [], body: ["messages"], jsonFields: ["messages"], structured: {}, renames: {}, arrayFields: [], dateTimeFields: [], nullableFields: [], binaryFields: [], rawBodyField: "", paginated: false, collection: true, idempotencyHeader: true, scopes: ["emails"] },
|
|
7
7
|
"email:get": { method: "GET", path: "/v1/email/messages/{message_id}", pathParams: ["message_id"], topLevel: ["message_id"], collections: ["additionalFields"], query: [], body: [], jsonFields: [], structured: {}, renames: {}, arrayFields: [], dateTimeFields: [], nullableFields: [], binaryFields: [], rawBodyField: "", paginated: false, collection: false, idempotencyHeader: false, scopes: ["emails"] },
|
|
8
|
-
"email:list": { method: "GET", path: "/v1/email/messages", pathParams: [], topLevel: [], collections: ["additionalFields"], query: ["limit", "starting_after", "ending_before", "created_after", "created_before", "broadcast_id", "status", "tag", "category", "to", "from"], body: [], jsonFields: [], structured: {}, renames: {}, arrayFields: ["tag"], dateTimeFields: ["created_after", "created_before"], nullableFields: [], binaryFields: [], rawBodyField: "", paginated: true, collection: true, idempotencyHeader: false, scopes: ["emails"] },
|
|
8
|
+
"email:list": { method: "GET", path: "/v1/email/messages", pathParams: [], topLevel: [], collections: ["additionalFields"], query: ["limit", "starting_after", "ending_before", "created_after", "created_before", "broadcast_id", "status", "tag", "reference", "category", "to", "from"], body: [], jsonFields: [], structured: {}, renames: {}, arrayFields: ["tag"], dateTimeFields: ["created_after", "created_before"], nullableFields: [], binaryFields: [], rawBodyField: "", paginated: true, collection: true, idempotencyHeader: false, scopes: ["emails"] },
|
|
9
9
|
"email:cancel": { method: "POST", path: "/v1/email/messages/{message_id}/cancel", pathParams: ["message_id"], topLevel: ["message_id"], collections: ["additionalFields"], query: [], body: [], jsonFields: [], structured: {}, renames: {}, arrayFields: [], dateTimeFields: [], nullableFields: [], binaryFields: [], rawBodyField: "", paginated: false, collection: false, idempotencyHeader: true, scopes: ["emails"] },
|
|
10
10
|
"email:stats_summary": { method: "GET", path: "/v1/email/stats/summary", pathParams: [], topLevel: [], collections: ["additionalFields"], query: ["from", "to", "timezone", "category", "sending_domain", "tag", "sending_ip", "recipient_domain", "template", "compare"], body: [], jsonFields: [], structured: {}, renames: {}, arrayFields: [], dateTimeFields: [], nullableFields: [], binaryFields: [], rawBodyField: "", paginated: false, collection: false, idempotencyHeader: false, scopes: ["emails"] },
|
|
11
11
|
"email:stats_daily": { method: "GET", path: "/v1/email/stats/daily", pathParams: [], topLevel: [], collections: ["additionalFields"], query: ["from", "to", "timezone", "category", "sending_domain", "tag", "sending_ip", "recipient_domain", "template"], body: [], jsonFields: [], structured: {}, renames: {}, arrayFields: [], dateTimeFields: [], nullableFields: [], binaryFields: [], rawBodyField: "", paginated: false, collection: true, idempotencyHeader: false, scopes: ["emails"] },
|
|
@@ -24,10 +24,10 @@ exports.birdRoutes = {
|
|
|
24
24
|
"email:stats_by_complaint_type": { method: "GET", path: "/v1/email/stats/complaint-types", pathParams: [], topLevel: [], collections: ["additionalFields", "sort"], query: ["starting_after", "ending_before", "from", "to", "timezone", "category", "sort", "limit"], body: [], jsonFields: [], structured: {}, renames: { "max_results": "limit" }, arrayFields: [], dateTimeFields: [], nullableFields: [], binaryFields: [], rawBodyField: "", paginated: true, collection: true, idempotencyHeader: false, scopes: ["emails"] },
|
|
25
25
|
"email:stats_by_broadcast": { method: "GET", path: "/v1/email/stats/broadcasts", pathParams: [], topLevel: [], collections: ["additionalFields", "sort"], query: ["starting_after", "ending_before", "from", "to", "timezone", "category", "sort", "limit"], body: [], jsonFields: [], structured: {}, renames: { "max_results": "limit" }, arrayFields: [], dateTimeFields: [], nullableFields: [], binaryFields: [], rawBodyField: "", paginated: true, collection: true, idempotencyHeader: false, scopes: ["email_marketing"] },
|
|
26
26
|
"email:templates_list": { method: "GET", path: "/v1/email/templates", pathParams: [], topLevel: [], collections: ["additionalFields"], query: ["scope", "category", "source", "theme", "q", "limit", "starting_after", "ending_before"], body: [], jsonFields: [], structured: {}, renames: {}, arrayFields: [], dateTimeFields: [], nullableFields: [], binaryFields: [], rawBodyField: "", paginated: true, collection: true, idempotencyHeader: false, scopes: ["email_management"] },
|
|
27
|
-
"sms:send": { method: "POST", path: "/v1/sms/messages", pathParams: [], topLevel: ["to"], collections: ["additionalFields"], query: [], body: ["to", "from", "text", "category", "tags", "metadata", "options", "template"], jsonFields: [], structured: { "tags": "list", "metadata": "map", "options": "struct", "template": "struct" }, renames: {}, arrayFields: [], dateTimeFields: [], nullableFields: [], binaryFields: [], rawBodyField: "", paginated: false, collection: false, idempotencyHeader: true, scopes: ["sms"] },
|
|
27
|
+
"sms:send": { method: "POST", path: "/v1/sms/messages", pathParams: [], topLevel: ["to"], collections: ["additionalFields"], query: [], body: ["to", "to_country_code", "from", "text", "binary", "category", "validity_period", "reference", "cost_center", "tags", "metadata", "options", "messaging_profile_id", "template"], jsonFields: [], structured: { "binary": "struct", "tags": "list", "metadata": "map", "options": "struct", "template": "struct" }, renames: {}, arrayFields: [], dateTimeFields: [], nullableFields: [], binaryFields: [], rawBodyField: "", paginated: false, collection: false, idempotencyHeader: true, scopes: ["sms"] },
|
|
28
28
|
"sms:send_batch": { method: "POST", path: "/v1/sms/batches", pathParams: [], topLevel: ["messages"], collections: ["additionalFields"], query: [], body: ["messages"], jsonFields: ["messages"], structured: {}, renames: {}, arrayFields: [], dateTimeFields: [], nullableFields: [], binaryFields: [], rawBodyField: "", paginated: false, collection: true, idempotencyHeader: true, scopes: ["sms"] },
|
|
29
29
|
"sms:get": { method: "GET", path: "/v1/sms/messages/{message_id}", pathParams: ["message_id"], topLevel: ["message_id"], collections: ["additionalFields"], query: [], body: [], jsonFields: [], structured: {}, renames: {}, arrayFields: [], dateTimeFields: [], nullableFields: [], binaryFields: [], rawBodyField: "", paginated: false, collection: false, idempotencyHeader: false, scopes: ["sms"] },
|
|
30
|
-
"sms:list": { method: "GET", path: "/v1/sms/messages", pathParams: [], topLevel: [], collections: ["additionalFields"], query: ["limit", "starting_after", "ending_before", "created_after", "created_before", "direction", "status", "error_code", "category", "to", "from", "country", "tag"], body: [], jsonFields: [], structured: {}, renames: {}, arrayFields: ["status", "error_code", "tag"], dateTimeFields: ["created_after", "created_before"], nullableFields: [], binaryFields: [], rawBodyField: "", paginated: true, collection: true, idempotencyHeader: false, scopes: ["sms"] },
|
|
30
|
+
"sms:list": { method: "GET", path: "/v1/sms/messages", pathParams: [], topLevel: [], collections: ["additionalFields"], query: ["limit", "starting_after", "ending_before", "created_after", "created_before", "direction", "status", "error_code", "category", "to", "from", "country", "tag", "reference"], body: [], jsonFields: [], structured: {}, renames: {}, arrayFields: ["status", "error_code", "tag"], dateTimeFields: ["created_after", "created_before"], nullableFields: [], binaryFields: [], rawBodyField: "", paginated: true, collection: true, idempotencyHeader: false, scopes: ["sms"] },
|
|
31
31
|
"sms_templates:list": { method: "GET", path: "/v1/sms/templates", pathParams: [], topLevel: [], collections: ["additionalFields", "sort"], query: ["scope", "category", "status", "language", "q", "sort", "order", "limit", "starting_after", "ending_before"], body: [], jsonFields: [], structured: {}, renames: {}, arrayFields: [], dateTimeFields: [], nullableFields: [], binaryFields: [], rawBodyField: "", paginated: true, collection: true, idempotencyHeader: false, scopes: ["sms_management"] },
|
|
32
32
|
"sms_templates:get": { method: "GET", path: "/v1/sms/templates/{template_ref}", pathParams: ["template_ref"], topLevel: ["template_ref"], collections: ["additionalFields"], query: [], body: [], jsonFields: [], structured: {}, renames: {}, arrayFields: [], dateTimeFields: [], nullableFields: [], binaryFields: [], rawBodyField: "", paginated: false, collection: false, idempotencyHeader: false, scopes: ["sms_management"] },
|
|
33
33
|
"sms:list_events": { method: "GET", path: "/v1/sms/messages/{message_id}/events", pathParams: ["message_id"], topLevel: ["message_id"], collections: ["additionalFields"], query: ["type"], body: [], jsonFields: [], structured: {}, renames: {}, arrayFields: [], dateTimeFields: [], nullableFields: [], binaryFields: [], rawBodyField: "", paginated: false, collection: true, idempotencyHeader: false, scopes: ["sms"] },
|
|
@@ -56,9 +56,9 @@ exports.birdRoutes = {
|
|
|
56
56
|
"sms_keyword_rules:create": { method: "POST", path: "/v1/sms/keyword-rules", pathParams: [], topLevel: ["keyword_operation"], collections: ["additionalFields"], query: [], body: ["operation", "country", "language", "number", "keywords", "reply", "confirmed_self_managed"], jsonFields: [], structured: {}, renames: { "keyword_operation": "operation" }, arrayFields: ["keywords"], dateTimeFields: [], nullableFields: ["country", "language", "number", "reply"], binaryFields: [], rawBodyField: "", paginated: false, collection: false, idempotencyHeader: true, scopes: ["sms_management"] },
|
|
57
57
|
"sms_keyword_rules:update": { method: "PATCH", path: "/v1/sms/keyword-rules/{id}", pathParams: ["id"], topLevel: ["id"], collections: ["updateFields"], query: [], body: ["keywords", "reply", "confirmed_self_managed"], jsonFields: [], structured: {}, renames: {}, arrayFields: ["keywords"], dateTimeFields: [], nullableFields: ["reply"], binaryFields: [], rawBodyField: "", paginated: false, collection: false, idempotencyHeader: true, scopes: ["sms_management"] },
|
|
58
58
|
"sms_keyword_rules:delete": { method: "DELETE", path: "/v1/sms/keyword-rules/{id}", pathParams: ["id"], topLevel: ["id"], collections: ["additionalFields"], query: [], body: [], jsonFields: [], structured: {}, renames: {}, arrayFields: [], dateTimeFields: [], nullableFields: [], binaryFields: [], rawBodyField: "", paginated: false, collection: false, idempotencyHeader: true, scopes: ["sms_management"] },
|
|
59
|
-
"whatsapp:send": { method: "POST", path: "/v1/whatsapp/messages", pathParams: [], topLevel: ["to"], collections: ["additionalFields"], query: [], body: ["to", "from", "template", "text", "image", "video", "audio", "sticker", "document", "location", "interactive", "contact_cards", "in_reply_to_message_id", "tags", "metadata"], jsonFields: ["template.components", "interactive.header", "interactive.buttons", "interactive.list", "interactive.cta_url", "interactive.cards", "contact_cards"], structured: { "template": "struct", "text": "struct", "image": "struct", "video": "struct", "audio": "struct", "sticker": "struct", "document": "struct", "location": "struct", "interactive": "struct", "tags": "list", "metadata": "map" }, renames: {}, arrayFields: [], dateTimeFields: [], nullableFields: [], binaryFields: [], rawBodyField: "", paginated: false, collection: false, idempotencyHeader: true, scopes: ["whatsapp"] },
|
|
59
|
+
"whatsapp:send": { method: "POST", path: "/v1/whatsapp/messages", pathParams: [], topLevel: ["to"], collections: ["additionalFields"], query: [], body: ["to", "from", "template", "text", "image", "video", "audio", "sticker", "document", "location", "interactive", "contact_cards", "in_reply_to_message_id", "tags", "metadata", "reference"], jsonFields: ["template.components", "interactive.header", "interactive.buttons", "interactive.list", "interactive.cta_url", "interactive.cards", "contact_cards"], structured: { "template": "struct", "text": "struct", "image": "struct", "video": "struct", "audio": "struct", "sticker": "struct", "document": "struct", "location": "struct", "interactive": "struct", "tags": "list", "metadata": "map" }, renames: {}, arrayFields: [], dateTimeFields: [], nullableFields: [], binaryFields: [], rawBodyField: "", paginated: false, collection: false, idempotencyHeader: true, scopes: ["whatsapp"] },
|
|
60
60
|
"whatsapp:get": { method: "GET", path: "/v1/whatsapp/messages/{message_id}", pathParams: ["message_id"], topLevel: ["message_id"], collections: ["additionalFields"], query: [], body: [], jsonFields: [], structured: {}, renames: {}, arrayFields: [], dateTimeFields: [], nullableFields: [], binaryFields: [], rawBodyField: "", paginated: false, collection: false, idempotencyHeader: false, scopes: ["whatsapp"] },
|
|
61
|
-
"whatsapp:list": { method: "GET", path: "/v1/whatsapp/messages", pathParams: [], topLevel: [], collections: ["additionalFields"], query: ["limit", "starting_after", "ending_before", "created_after", "created_before", "status", "direction", "to", "from", "phone_number", "bsuid", "category", "group_id", "tag"], body: [], jsonFields: [], structured: {}, renames: {}, arrayFields: ["status", "tag"], dateTimeFields: ["created_after", "created_before"], nullableFields: [], binaryFields: [], rawBodyField: "", paginated: true, collection: true, idempotencyHeader: false, scopes: ["whatsapp"] },
|
|
61
|
+
"whatsapp:list": { method: "GET", path: "/v1/whatsapp/messages", pathParams: [], topLevel: [], collections: ["additionalFields"], query: ["limit", "starting_after", "ending_before", "created_after", "created_before", "status", "direction", "to", "from", "phone_number", "bsuid", "category", "group_id", "tag", "reference"], body: [], jsonFields: [], structured: {}, renames: {}, arrayFields: ["status", "tag"], dateTimeFields: ["created_after", "created_before"], nullableFields: [], binaryFields: [], rawBodyField: "", paginated: true, collection: true, idempotencyHeader: false, scopes: ["whatsapp"] },
|
|
62
62
|
"whatsapp:list_events": { method: "GET", path: "/v1/whatsapp/messages/{message_id}/events", pathParams: ["message_id"], topLevel: ["message_id"], collections: ["additionalFields"], query: ["type"], body: [], jsonFields: [], structured: {}, renames: {}, arrayFields: [], dateTimeFields: [], nullableFields: [], binaryFields: [], rawBodyField: "", paginated: false, collection: true, idempotencyHeader: false, scopes: ["whatsapp"] },
|
|
63
63
|
"voice:legs_list": { method: "GET", path: "/v1/voice/legs", pathParams: [], topLevel: [], collections: ["additionalFields"], query: ["direction", "status", "call_id", "sip_trunk_id", "from", "to", "number", "tag", "started_after", "started_before", "limit", "starting_after", "ending_before"], body: [], jsonFields: [], structured: {}, renames: {}, arrayFields: ["status", "tag"], dateTimeFields: ["started_after", "started_before"], nullableFields: [], binaryFields: [], rawBodyField: "", paginated: true, collection: true, idempotencyHeader: false, scopes: ["voice"] },
|
|
64
64
|
"voice:legs_get": { method: "GET", path: "/v1/voice/legs/{leg_id}", pathParams: ["leg_id"], topLevel: ["leg_id"], collections: ["additionalFields"], query: [], body: [], jsonFields: [], structured: {}, renames: {}, arrayFields: [], dateTimeFields: [], nullableFields: [], binaryFields: [], rawBodyField: "", paginated: false, collection: false, idempotencyHeader: false, scopes: ["voice"] },
|
|
@@ -102,7 +102,7 @@ exports.birdRoutes = {
|
|
|
102
102
|
"webhooks:create": { method: "POST", path: "/v1/webhooks", pathParams: [], topLevel: ["events"], collections: ["additionalFields"], query: [], body: ["url", "filter", "events", "description"], jsonFields: [], structured: { "filter": "struct" }, renames: {}, arrayFields: ["events"], dateTimeFields: [], nullableFields: [], binaryFields: [], rawBodyField: "", paginated: false, collection: false, idempotencyHeader: true, scopes: ["webhooks"] },
|
|
103
103
|
"webhooks:test": { method: "POST", path: "/v1/webhooks/{webhook_id}/test", pathParams: ["webhook_id"], topLevel: ["webhook_id"], collections: ["additionalFields"], query: [], body: ["event_type"], jsonFields: [], structured: {}, renames: {}, arrayFields: [], dateTimeFields: [], nullableFields: [], binaryFields: [], rawBodyField: "", paginated: false, collection: false, idempotencyHeader: true, scopes: ["webhooks"] },
|
|
104
104
|
"webhooks:delete": { method: "DELETE", path: "/v1/webhooks/{webhook_id}", pathParams: ["webhook_id"], topLevel: ["webhook_id"], collections: ["additionalFields"], query: [], body: [], jsonFields: [], structured: {}, renames: {}, arrayFields: [], dateTimeFields: [], nullableFields: [], binaryFields: [], rawBodyField: "", paginated: false, collection: false, idempotencyHeader: true, scopes: ["webhooks"] },
|
|
105
|
-
"webhooks:attempts": { method: "GET", path: "/v1/webhooks/{webhook_id}/attempts", pathParams: ["webhook_id"], topLevel: ["webhook_id"], collections: ["additionalFields"], query: ["limit", "before", "after"], body: [], jsonFields: [], structured: {}, renames: { "max_results": "limit" }, arrayFields: [], dateTimeFields: ["before", "after"], nullableFields: [], binaryFields: [], rawBodyField: "", paginated:
|
|
105
|
+
"webhooks:attempts": { method: "GET", path: "/v1/webhooks/{webhook_id}/attempts", pathParams: ["webhook_id"], topLevel: ["webhook_id"], collections: ["additionalFields"], query: ["limit", "before", "after", "starting_after", "ending_before"], body: [], jsonFields: [], structured: {}, renames: { "max_results": "limit" }, arrayFields: [], dateTimeFields: ["before", "after"], nullableFields: [], binaryFields: [], rawBodyField: "", paginated: true, collection: true, idempotencyHeader: false, scopes: ["webhooks"] },
|
|
106
106
|
"webhooks:replay": { method: "POST", path: "/v1/webhooks/{webhook_id}/replay", pathParams: ["webhook_id"], topLevel: ["webhook_id"], collections: ["additionalFields"], query: [], body: ["since", "until"], jsonFields: [], structured: {}, renames: {}, arrayFields: [], dateTimeFields: ["since", "until"], nullableFields: [], binaryFields: [], rawBodyField: "", paginated: false, collection: false, idempotencyHeader: true, scopes: ["webhooks"] },
|
|
107
107
|
"webhooks:rotate_secret": { method: "POST", path: "/v1/webhooks/{webhook_id}/rotate-secret", pathParams: ["webhook_id"], topLevel: ["webhook_id"], collections: ["additionalFields"], query: [], body: [], jsonFields: [], structured: {}, renames: {}, arrayFields: [], dateTimeFields: [], nullableFields: [], binaryFields: [], rawBodyField: "", paginated: false, collection: false, idempotencyHeader: true, scopes: ["webhooks"] },
|
|
108
108
|
"webhooks:update": { method: "PATCH", path: "/v1/webhooks/{webhook_id}", pathParams: ["webhook_id"], topLevel: ["webhook_id"], collections: ["updateFields"], query: [], body: ["url", "description", "filter", "events", "destination", "status"], jsonFields: ["destination.connector"], structured: { "filter": "struct", "destination": "struct" }, renames: {}, arrayFields: ["events"], dateTimeFields: [], nullableFields: ["filter"], binaryFields: [], rawBodyField: "", paginated: false, collection: false, idempotencyHeader: true, scopes: ["webhooks"] },
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@messagebird/n8n-nodes-bird",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.32.0",
|
|
4
4
|
"description": "The official Bird node for n8n: email, SMS, WhatsApp, and verification, plus a webhook trigger for Bird events.",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"author": {
|
|
@@ -54,7 +54,7 @@
|
|
|
54
54
|
"n8n-workflow": "*"
|
|
55
55
|
},
|
|
56
56
|
"devDependencies": {
|
|
57
|
-
"@n8n/scan-community-package": "0.
|
|
57
|
+
"@n8n/scan-community-package": "0.40.0",
|
|
58
58
|
"@types/node": "22.20.5",
|
|
59
59
|
"n8n-workflow": "2.16.0",
|
|
60
60
|
"rimraf": "6.1.3",
|