Skip to content

Commit 385e17e

Browse files
marijahorvat171ivicac
authored andcommitted
2040 - json and docs generated
1 parent f7dede4 commit 385e17e

2 files changed

Lines changed: 37 additions & 13 deletions

File tree

  • docs/content/docs/reference/components
  • server/libs/modules/components/brevo/src/test/resources/definition

docs/content/docs/reference/components/brevo_v1.mdx

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,7 @@ Type: OBJECT
108108
### Update Contact
109109
Name: updateContact
110110

111-
`Updates existing contact.`
111+
`Updates an existing contact.`
112112

113113
#### Properties
114114

@@ -144,7 +144,7 @@ This action does not produce any output.
144144
### Send Transactional Email
145145
Name: sendTransactionalEmail
146146

147-
`Sends and email from your Brevo account.`
147+
`Sends an email from your Brevo account.`
148148

149149
#### Properties
150150

@@ -232,3 +232,9 @@ The output for this action is dynamic and may vary depending on the input parame
232232

233233

234234

235+
## What to do if your action is not listed here?
236+
237+
If this component doesn't have the action you need, you can use **Custom Action** to create your own. Custom Actions empower you to define HTTP requests tailored to your specific requirements, allowing for greater flexibility in integrating with external services or APIs.
238+
239+
To create a Custom Action, simply specify the desired HTTP method, path, and any necessary parameters. This way, you can extend the functionality of your component beyond the predefined actions, ensuring that you can meet all your integration needs effectively.
240+

server/libs/modules/components/brevo/src/test/resources/definition/brevo_v1.json

Lines changed: 29 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,10 @@
66
"beforeTimeoutResume": null,
77
"deprecated": null,
88
"description": "Creates new contact.",
9-
"help": null,
9+
"help": {
10+
"body": "",
11+
"learnMoreUrl": "https://docs.bytechef.io/reference/components/brevo_v1#create-contact"
12+
},
1013
"metadata": null,
1114
"name": "createContact",
1215
"outputDefinition": {
@@ -172,8 +175,11 @@
172175
"beforeSuspend": null,
173176
"beforeTimeoutResume": null,
174177
"deprecated": null,
175-
"description": "Updates existing contact.",
176-
"help": null,
178+
"description": "Updates an existing contact.",
179+
"help": {
180+
"body": "",
181+
"learnMoreUrl": "https://docs.bytechef.io/reference/components/brevo_v1#update-contact"
182+
},
177183
"metadata": null,
178184
"name": "updateContact",
179185
"outputDefinition": null,
@@ -255,8 +261,11 @@
255261
"beforeSuspend": null,
256262
"beforeTimeoutResume": null,
257263
"deprecated": null,
258-
"description": "Sends and email from your Brevo account.",
259-
"help": null,
264+
"description": "Sends an email from your Brevo account.",
265+
"help": {
266+
"body": "",
267+
"learnMoreUrl": "https://docs.bytechef.io/reference/components/brevo_v1#send-transactional-email"
268+
},
260269
"metadata": null,
261270
"name": "sendTransactionalEmail",
262271
"outputDefinition": {
@@ -778,7 +787,7 @@
778787
"workflowNodeDescription": null
779788
}, {
780789
"name": "updateContact",
781-
"description": "Updates existing contact.",
790+
"description": "Updates an existing contact.",
782791
"element": { },
783792
"help": null,
784793
"outputDefinition": null,
@@ -861,7 +870,7 @@
861870
"workflowNodeDescription": null
862871
}, {
863872
"name": "sendTransactionalEmail",
864-
"description": "Sends and email from your Brevo account.",
873+
"description": "Sends an email from your Brevo account.",
865874
"element": { },
866875
"help": null,
867876
"outputDefinition": {
@@ -1290,14 +1299,20 @@
12901299
"type": "API_KEY"
12911300
} ],
12921301
"baseUri": { },
1293-
"help": null,
1302+
"help": {
1303+
"body": "",
1304+
"learnMoreUrl": "https://docs.bytechef.io/reference/components/brevo_v1#connection-setup"
1305+
},
12941306
"processErrorResponse": null,
12951307
"properties": null,
12961308
"test": null,
12971309
"version": 1
12981310
},
1299-
"customAction": null,
1300-
"customActionHelp": null,
1311+
"customAction": true,
1312+
"customActionHelp": {
1313+
"body": "",
1314+
"learnMoreUrl": "https://developers.brevo.com/docs/quickstart-reference"
1315+
},
13011316
"description": "Brevo is an email marketing platform that offers a cloud-based marketing communication software suite with transactional email, marketing automation, customer-relationship management and more.",
13021317
"icon": "path:assets/brevo.svg",
13031318
"metadata": null,
@@ -1311,7 +1326,10 @@
13111326
"deprecated": null,
13121327
"description": "Triggers when transactional email is opened.",
13131328
"dynamicWebhookRefresh": null,
1314-
"help": null,
1329+
"help": {
1330+
"body": "",
1331+
"learnMoreUrl": "https://docs.bytechef.io/reference/components/brevo_v1#transactional-email-opened"
1332+
},
13151333
"listenerDisable": null,
13161334
"listenerEnable": null,
13171335
"name": "transactionalEmailOpened",

0 commit comments

Comments
 (0)