Update 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 webhookId = 1;

let updateWebhook = new SibApiV3Sdk.UpdateWebhook();

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

apiInstance.updateWebhook(webhookId, updateWebhook).then(function() {
    console.log('API called successfully.');
}, 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
);
$webhookId = 1;
$updateWebhook = new \SendinBlue\Client\Model\UpdateWebhook(); 
$updateWebhook['url'] = 'https://example.com/notifyurl';
$updateWebhook['description'] = 'webhook description';
$updateWebhook['events'] = array('request', 'delivered', 'hardBounce', 'softBounce', 'blocked', 'spam', 'invalid');
$updateWebhook['type'] = 'transactional';

try {
    $apiInstance->updateWebhook($webhookId, $updateWebhook);
} catch (Exception $e) {
    echo 'Exception when calling WebhooksApi->updateWebhook: ', $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))
webhook_id = 1
update_webhook = sib_api_v3_sdk.UpdateWebhook(description = 'Webhook description', url = 'https://example.com/notifyurl', events = ['request', 'delivered'], type = 'transactional')

try:
    api_response = api_instance.update_webhook(webhook_id, update_webhook)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling WebhooksApi->update_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 webhookId = 1;

let updateWebhook = new SibApiV3Sdk.UpdateWebhook();

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

apiInstance.updateWebhook(webhookId, updateWebhook).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();
            long? webhookId = 1;
            string url = "https://example.com/notifyurl";
            string description = "webhook description";
            List<UpdateWebhook.EventsEnum> events = new List<UpdateWebhook.EventsEnum>();
            events.Add(UpdateWebhook.EventsEnum.Request);
            events.Add(UpdateWebhook.EventsEnum.Delivered);
            events.Add(UpdateWebhook.EventsEnum.HardBounce);
            events.Add(UpdateWebhook.EventsEnum.SoftBounce);
            events.Add(UpdateWebhook.EventsEnum.Blocked);
            events.Add(UpdateWebhook.EventsEnum.Spam);
            events.Add(UpdateWebhook.EventsEnum.Invalid);
            try
            {
                var updateWebhook = new UpdateWebhook(url, description, events);
                apiInstance.UpdateWebhook(webhookId, updateWebhook);
                Console.ReadLine();
            }
            catch (Exception e)
            {
                Debug.WriteLine(e.Message);
                Console.WriteLine(e.Message);
                Console.ReadLine();
            }
        }
    }
}
# load the gem
require 'sib-api-v3-sdk'
# setup authorization
SibApiV3Sdk.configure do |config|
  # Configure API key authorization: api-key
  config.api_key['api-key'] = 'YOUR API KEY'
end

api_instance = SibApiV3Sdk::WebhooksApi.new

webhook_id = 789 # Integer | Id of the webhook

update_webhook = SibApiV3Sdk::UpdateWebhook.new # UpdateWebhook | Values to update a webhook

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

begin
  #Update a webhook
  api_instance.update_webhook(webhook_id, update_webhook)
rescue SibApiV3Sdk::ApiError => e
  puts "Exception when calling WebhooksApi->update_webhook: #{e}"
end
Language
Authorization
Header
Click Try It! to start a request and see the response here!