Put topics about this connector package here.
Always check the ‘How to use the Alumio connector packages’ topic.
Extra information
System documentation: Sinch Mailjet API Reference
Setting up HTTP Client Sinch Mailjet
Steps
-
In Alumio Dashboard, go to Connections > HTTPS (API). Create a new HTTP Client and select Sinch Mailjet HTTP Client as the prototype of the HTTP Client.
-
Fill in the Base URI, Api Key, and Secret Key.
Subscribing to Entities from Sinch Mailjet
Steps
-
Go to Integrations-> Incoming and create a new incoming configuration and select Sinch Mailjet Subscriber as the subscriber.
-
Select the method and entity you want to subscribe to from Sinch Mailjet.
-
Add any request parameters needed to subscribe to the entity (optional).
-
You can optionally add a transformer to transform the request parameters into something you need.
-
Select the Sinch Mailjet HTTP Client to use.
General Concept
We follow Sinch Mailjet documentation on building this connector so you can easily use the connector based on Sinch Mailjet API Reference.
Entity
It’s the entity you want to subscribe from Sinch Mailjet. Please refer to the entities in Management APIs from the Sinch Mailjet API Reference page.
Request Parameters
These are the parameters you can provide to get the needed entity based on Sinch Mailjet API Reference. Please look at the example below on how to fill Request Parameters field when subscribing Single Request entity
- Path is the path parameter of the url. For example, the {contact_id}.
- Query is a defined set of parameters attached to the end of a url.
Example: URL.com - MediaOptions
That’s why we need to define contact_ID property inside path property in the Request Parameters field. The properties inside query parameters will be parsed as query parameters. Here is the final URL that will be called when using such Request Parameters field on the coupon entity.
/v3/REST/contact/123123123123
Input Transformer
Any transformer’s set here will be executed after the Request Parameters are loaded. So, you basically can add any transformer to provide and transform the request parameters into anything you need, either as path parameters and/or as query parameters of an entity.
HTTP Client
It’s the HTTP Client configuration or prototype you will use to access Sinch Mailjet.
Publishing Entity to Sinch Mailjet
Steps
- Go to Integrations-> Outgoing, create a new outgoing configuration, and select Sinch MailjetPublisher as the publisher.
- Select the method that you want the publisher to do with the data.
- Select the Sinch Mailjet entity you want the data to be published to.
- Select the HTTP Client to use.
General Concept
Like the subscriber, the publisher has similar methods on how to use it. The difference is the payload that will be submitted by the publisher originating from the data (from routes, from transformers in outgoing configuration).
Method
Currently, we support Post (HTTP POST method),Put (HTTP PUTmethod), and Delete (HTTP DELETE method).
Entity
We support publishing to most Sinch Mailjet endpoints but not with publishing binary files at the moment. Please refer to the entities in Management APIs from Sinch Mailjet API Reference page. Based on the documentation, some endpoints may need one or more path parameters.
For endpoints that require an object as the request payload, please look at the example below. For example, we want to Create a Contact. Please select “Post” as the action and “Create a new contact” as the entity of the publisher.
You can put the payload you want to send to Sinch Mailjet into the payload property in the data. Here is an example of the Possible Response after Creation.
- Path is the path parameter of the url. For example, the {id}.
- Query is a defined set of parameters attached to the end of a url.
Example: URL.com - MediaOptions - Payload is the data contained within a request.
Alumio will send an API request to Sinch Mailjet with URL /v3/REST/contact
HTTP Client
It’s the HTTP Client configuration or prototype you will use to access Sinch Mailjet.