Create a webhook

Code Examples

You can use as reference the code below to implement this call in your preferred language.
Check all our official API clients here

const SibApiV3Sdk = require('sib-api-v3-sdk');
const defaultClient = SibApiV3Sdk.ApiClient.instance;

let apiKey = defaultClient.authentications['api-key'];
apiKey.apiKey = 'YOUR API KEY';

let apiInstance = new SibApiV3Sdk.WebhooksApi();

let createWebhook = new SibApiV3Sdk.CreateWebhook();

createWebhook = {
    description = 'string',
    url = 'https://example.com/notifyurl',
    events = ['string1', 'string2'],
    type = 'string'
}

apiInstance.createWebhook(createWebhook).then(function(data) {
    console.log('API called successfully. Returned data: ' + JSON.stringify(data));
}, function(error) {
    console.error(error);
});
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR API KEY');

$apiInstance = new SendinBlue\Client\Api\WebhooksApi(
    new GuzzleHttp\Client(),
    $config
);
$createWebhook = new \SendinBlue\Client\Model\CreateWebhook(); 
$createWebhook['url'] = 'https://example.com/notifyurl';
$createWebhook['description'] = 'webhook description';
$createWebhook['events'] = array('request', 'delivered', 'hardBounce', 'softBounce', 'blocked', 'spam', 'invalid');
$createWebhook['type'] = 'transactional';

try {
    $result = $apiInstance->createWebhook($createWebhook);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling WebhooksApi->createWebhook: ', $e->getMessage(), PHP_EOL;
}
?>
from __future__ import print_function
import time
import sib_api_v3_sdk
from sib_api_v3_sdk.rest import ApiException
from pprint import pprint

configuration = sib_api_v3_sdk.Configuration()
configuration.api_key['api-key'] = 'YOUR API KEY'

api_instance = sib_api_v3_sdk.WebhooksApi(sib_api_v3_sdk.ApiClient(configuration))
create_webhook = sib_api_v3_sdk.CreateWebhook(description = 'string description', url = 'https://example.com/notifyurl', events = ['string1', 'string2'], type = 'string')

try:
    api_response = api_instance.create_webhook(create_webhook)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling WebhooksApi->create_webhook: %s\n" % e)
const SibApiV3Sdk = require('sib-api-v3-typescript');
 
let apiInstance = new SibApiV3Sdk.WebhooksApi()

let apiKey = apiInstance.authentications['apiKey'];
apiKey.apiKey = 'YOUR API KEY';

let createWebhook = new SibApiV3Sdk.CreateWebhook();

createWebhook.description = 'webhook description';
createWebhook.url = 'https://example.com/notifyurl';
createWebhook.events = ['request', 'delivered', 'hardBounce', 'softBounce', 'blocked', 'spam', 'invalid'];
createWebhook.type = 'transactional';

apiInstance.createWebhook(createWebhook).then(function(data) {
  console.log('API called successfully. Returned data: ' + JSON.stringify(data));
}, function(error) {
  console.error(error);
});
using sib_api_v3_sdk.Api;
using sib_api_v3_sdk.Client;
using sib_api_v3_sdk.Model;
using System;
using System.Collections.Generic;
using System.Diagnostics;

namespace Sendinblue
{
    class Program
    {
        static void Main(string[] args)
        {
            Configuration.Default.ApiKey.Add("api-key", "YOUR API KEY");

            var apiInstance = new WebhooksApi();
            string url = "https://example.com/notifyurl";
            string description = "webhook description";
            List<CreateWebhook.EventsEnum> events = new List<CreateWebhook.EventsEnum>();
            events.Add(CreateWebhook.EventsEnum.Request);
            events.Add(CreateWebhook.EventsEnum.Delivered);
            events.Add(CreateWebhook.EventsEnum.HardBounce);
            events.Add(CreateWebhook.EventsEnum.SoftBounce);
            events.Add(CreateWebhook.EventsEnum.Blocked);
            events.Add(CreateWebhook.EventsEnum.Spam);
            events.Add(CreateWebhook.EventsEnum.Invalid);

            CreateWebhook.TypeEnum type = CreateWebhook.TypeEnum.Transactional;
            try
            {
                var createWebhook = new CreateWebhook(url, description, events, type);
                CreateModel result = apiInstance.CreateWebhook(createWebhook);
                Debug.WriteLine(result.ToJson());
                Console.WriteLine(result.ToJson());
                Console.ReadLine();
            }
            catch (Exception e)
            {
                Debug.WriteLine(e.Message);
                Console.WriteLine(e.Message);
                Console.ReadLine();
            }
        }
    }
}
Language
Authentication
Header
Response
Click Try It! to start a request and see the response here!