Create a webhook

1 min

POST

https://api.campaign.episerver.net/rest/{clientId}/webhooks

Path Parameters

clientIdinteger<int64>required
Description
Client ID
Format
int64

Header Parameters

acceptstring
Description
Generated from available response content types
Default
application/json
Allowed
application/jsonapplication/vnd.optivo.broadmail.v1+json

Form Parameters

basicAuthUsernamestring
Description
User name for Basic HTTP Authentication. This parameter is deprecated and might be removed in the near future. Please use <authentication> instead.
basicAuthPasswordstring
Description
Password for Basic HTTP Authentication. This parameter is deprecated and might be removed in the near future. Please use <authentication> instead.
typestring<open | click | sent | bounce | unsubscribe | spamcomplaint | singleoptin | confirmedoptin | doubleoptin | blocklist | archive | filteredbyblocklist>required
Description
Event data type
Allowed
openclicksentbounceunsubscribespamcomplaintsingleoptinconfirmedoptindoubleoptinblocklistarchivefilteredbyblocklist
formatstring<json>required
Description
Data format in which the event data is to be sent
Allowed
json
authenticationstring
Description
Authentication method and attributes as json. Current types are:

or

or
targetUrlstringrequired
Description
Target URL to which the event data is to be sentNote: The URL must be accessible and able to receive data via HTTP POST requests from the IP address 193.169.180.1 at any time. Use the current HTTPS version and standard port 443 for HTTPS connections.

Responses

201The webhook was created successfully.

RestWebhook
- idinteger<int64>
  Description
  Webhook ID
  Format
  int64
- typestring<open | click | sent | bounce | unsubscribe | spamcomplaint | webhooknode | singleoptin | confirmedoptin | doubleoptin | blocklist | archived | filteredbyblocklist>
  Description
  Type of the event data
  Allowed
  openclicksentbounceunsubscribespamcomplaintwebhooknodesingleoptinconfirmedoptindoubleoptinblocklistarchivedfilteredbyblocklist
- statusstring<created | activated | deactivated | deleted | suspended>
  Description
  Webhook status
  Allowed
  createdactivateddeactivateddeletedsuspended
- formatstring<json>
  Description
  Data format of the event data
  Allowed
  json
- targetUrlstring
  Description
  Target URL
- authenticationWebhookAuthentication
  Description
  Authentication method and attributes
  - typestringrequired
- createdstring<date-time>
  Description
  Creation date
  Format
  date-time
- modifiedstring<date-time>
  Description
  Modification date
  Format
  date-time

400

The webhook could not be created (either url, type or format was wrong).

RestWebhook
- idinteger<int64>
  Description
  Webhook ID
  Format
  int64
- typestring<open | click | sent | bounce | unsubscribe | spamcomplaint | webhooknode | singleoptin | confirmedoptin | doubleoptin | blocklist | archived | filteredbyblocklist>
  Description
  Type of the event data
  Allowed
  openclicksentbounceunsubscribespamcomplaintwebhooknodesingleoptinconfirmedoptindoubleoptinblocklistarchivedfilteredbyblocklist
- statusstring<created | activated | deactivated | deleted | suspended>
  Description
  Webhook status
  Allowed
  createdactivateddeactivateddeletedsuspended
- formatstring<json>
  Description
  Data format of the event data
  Allowed
  json
- targetUrlstring
  Description
  Target URL
- authenticationWebhookAuthentication
  Description
  Authentication method and attributes
  - typestringrequired
- createdstring<date-time>
  Description
  Creation date
  Format
  date-time
- modifiedstring<date-time>
  Description
  Modification date
  Format
  date-time

curl

curl --request POST \
     --url https://api.campaign.episerver.net/rest/{clientId}/webhooks \
     --header 'accept: application/json' \
     --header 'content-type: application/x-www-form-urlencoded' \
     --data 'type=open' \
     --data 'format=json' \
     --data 'targetUrl=string'

javascript

var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/x-www-form-urlencoded");

var urlencoded = new URLSearchParams();
urlencoded.append("type", "open");
urlencoded.append("format", "json");
urlencoded.append("targetUrl", "string");

var requestOptions = {
   method: 'POST',
   headers: myHeaders,
   body: urlencoded,
   redirect: 'follow'
};

fetch("https://api.campaign.episerver.net/rest/{clientId}/webhooks", requestOptions)
   .then(response => response.text())
   .then(result => console.log(result))
   .catch(error => console.log('error', error));

ruby

require "uri"
require "net/http"

url = URI("https://api.campaign.episerver.net/rest/{clientId}/webhooks")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Post.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/x-www-form-urlencoded"
request.body = "type=open&format=json&targetUrl=string"

response = https.request(request)
puts response.read_body

python

import requests

url = "https://api.campaign.episerver.net/rest/{clientId}/webhooks"

payload = 'type=open&format=json&targetUrl=string'
headers = {
   'accept': 'application/json',
   'content-type': 'application/x-www-form-urlencoded'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)

201

// The webhook was created successfully.
{
  "id": "",
  "type": "",
  "status": "",
  "format": "",
  "targetUrl": "",
  "authentication": {
    "type": ""
  },
  "created": "",
  "modified": ""
}

400

// The webhook could not be created (either url, type or format was wrong).
{
  "id": "",
  "type": "",
  "status": "",
  "format": "",
  "targetUrl": "",
  "authentication": {
    "type": ""
  },
  "created": "",
  "modified": ""
}