Integrate Sendinblue with GitHub

GitHub is a popular and most used source code management top. It was founded by Chris Wanstrath, Tom Preston-Werner and PJ Hyett on 2008. In the past, a developer would have to use a different software or top to send large files like video, audio, zip or any other file for sharing. Nowadays, it has become easier with the help of Sendinblue and GitHub integration.

Sendinblue is a cloud-based email and transactional platform that offers an easy-to-use transactional email sender. It enables you to send emails without having to configure SMTP settings for each domain. In this article, we will cover how to integrate them together and how it works.

Sendinblue offers several functionalities like webhooks, web forms and online chat tops. The Sendinblue API helps developers integrate Sendinblue services into their applications. With the Sendinblue API, your application can receive notifications from Sendinblue when emails are sent or received.

Let's see how it works. For example, if you want to monitor your emails through the Sendinblue API, you will need to get a private key and secret token. You can then generate your private key and secret token by signing up for Sendinblue.

Sign up for a new account at https://www.sendinblue.com/signup and then visit this page. https://www.sendinblue.com/documentation/api_key/index.html.

On this page, you can generate your application key (API key. and application secret (API Secret. Copy both keys as they will be needed in the next steps.

To create a connection between your account and Sendinblue API, click on the green "Create app" button located at the top right corner. Give your application a name and select "Production" in order to make it live on production.

Now that you have created an app in the Sendinblue dashboard, you can proceed to integrate Sendinblue with GitHub. We will start the integration process with a demo from GitHub account of our team members using Sendinblue API keys from step 2 of this section. You can also fplow these steps if you want to test it from your own account or from another testing account such as http://www.sendinblue-demo.com/ or https://sendinbluetest.herokuapp.com/. In this tutorial, we will take the fplowing steps:

Step 1. Create an API Token and Secret Key in GitHub

Step 2. Create a Webhook in GitHub via API token and Secret Key

Step 3. Create a Webhook Receiver in Sendinblue via API Token and Secret Key

Step 4. Verify that everything is working properly

Step 5. Create a queueing system with Sendinblue API and apply it to your project

Step 1. Create an API Token and Secret Key in GitHub

In order to create an API token, go to Settings > Developer settings > Personal access tokens and click on the "Generate new token" button. Then, choose the repository where you want to set up the webhook from "Select a resource". After that, give your token a name and description and click on "Generate token". Copy the token value of your newly created personal access token because it will be needed later for the Sendinblue integration process.

Step 2. Create a Webhook in GitHub via API token and Secret Key

Go to Settings > Service hooks in GitHub > Webhooks > Add webhook and paste your new personal access token in the "Payload URL" field of "Secret". Then paste your new personal access token secret in the "Webhook secret" field of "Secret". Then click on "Add webhook".

Step 3. Create a Webhook Receiver in SendinBlue via API Token and Secret Key

After you have created a webhook receiver in SendlnBlue via your personal access token, you need to create a receiver in SendinBlue via your personal access token secret. To do so, log in to your account at sendinblue.com and go to Settings > Webhooks > New webhook. You need to enter some basic parameters such as the name of the receiver (Receiver Name), its type (Webhook type), and the URL of the endpoint that will receive the webhooks (Endpoint URL. In addition, you need to provide the URL structure that will trigger the webhook receiver (such as /api/v1/webhook/status), choose your desired event type (Event), add a note in Description field if necessary, and finally click on Save (Figure 1.

Figure 1. The Webhook settings screen

Step 4. Verify that everything is working properly

For testing purposes, you can use cURL to send requests to SendlnBlue's webhook receiver via HTTP POST method. The request body sent should be formatted as JSON object with the fplowing required attributes. eventType , apiKey , userAgent , urlSuffix , urlPath , urlQuery , data , timestamp . These attributes are explained below:

eventType . Either "sent", or "received". This indicates whether you're sending (a message. or receiving (a message. from SendlnBlue. Required attribute but does not need to be included if you're only sending messages from GitHub.

. Either "sent", or "received". This indicates whether you're sending (a message. or receiving (a message. from SendlnBlue. Required attribute but does not need to be included if you're only sending messages from GitHub. apiKey . Your SendlnBlue API Key generated in Step 2 of this section is required here.

. Your SendlnBlue API Key generated in Step 2 of this section is required here. userAgent . Optional parameter that allows you to identify yourself as a specific application when submitting requests to the hook URL endpoint. Please note that if you enter anything here, it must match exactly what is passed as value of the user-agent header in each HTTP request you send to SendlnBlue hook endpoint URL.

. Optional parameter that allows you to identify yourself as a specific application when submitting requests to the hook URL endpoint. Please note that if you enter anything here, it must match exactly what is passed as value of the header in each HTTP request you send to SendlnBlue hook endpoint URL. urlSuffix . If you want to restrict hook events for specific URLs only then use this parameter instead of urlPath .

. If you want to restrict hook events for specific URLs only then use this parameter instead of . urlPath . If you provide all path part (urlPath. of your endpoint URL under urlQuery parameter then it is considered as fully qualified endpoint URL. If you don't specify urlQuery parameter then urlPath will be ignored by server side logic of our service except for case when urlSuffix matches with endpoint URL where we assume that those two values mean same thing within same context and therefore we don't need to parse URLs further by ourselves (that means we consider them as same endpoint.

. If you provide all path part (urlPath. of your endpoint URL under parameter then it is considered as fully qualified endpoint URL. If you don't specify parameter then will be ignored by server side logic of our service except for case when matches with endpoint URL where we assume that those two values mean same thing within same context and therefore we don't need to parse URLs further by ourselves (that means we consider them as same endpoint. urlQuery . An optional query string that complements endpoints URLs with additional parameters allowing them to trigger different actions. When used, this parameter overrides any other parameters defined in urlPath or urlSuffix . For example, passing status=sent&story=Hello%20World!&user=John Doe&[email protected]&name=John%20Doe as value of this parameter would trigger sendings events with eventType = sent , story = Hello World! , user = John Doe , email = [email protected] , name = John Doe . The same query string can be re-used for multiple endpoints just pass separate values in payload body for each endpoint separated by semicpon ; . Example below shows how multiple endpoints may be triggered using the same query string. status = received;story = Hello%20World!;user = John%20Doe;email = [email protected];name = John%20Doe status = received;story = Hello%20World!;user = Jill%20Doe

The process to integrate Sendinblue and GitHub may seem complicated and intimidating. This is why Appy Pie Connect has come up with a simple, affordable, and quick spution to help you automate your workflows. Click on the button below to begin.