POST webhook/test/deployment

[HTTP POST] ~/webhook/test/deployment

Description: Testing endpoint for webhooks. Sends an email or SMS as part of Deployment Campaign.

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
Id	integer	None.
AuthToken	string	None.
EventType	string	None.
EventDate	date	None.
CampaignId	integer	None.
EmailId	integer	None.
TextMessageId	integer	None.
LandingPageId	integer	None.
IsTest	boolean	None.
Contact	ContactDTO	None.
UploadId	integer	None.
UploadPath	string	None.
TrackId	integer	None.
EDocumentId	integer	None.
TrafficSource	string	None.

Formats

application/json, text/json

Sample:

{
  "Id": 1,
  "AuthToken": "sample string 2",
  "EventType": "sample string 3",
  "EventDate": "2025-05-09T13:16:49.0302427+01:00",
  "CampaignId": 1,
  "EmailId": 1,
  "TextMessageId": 1,
  "LandingPageId": 1,
  "IsTest": true,
  "Contact": {
    "EncContactId": "sample string 2",
    "ListId": 3,
    "Values": {
      "sample string 1": {},
      "sample string 3": {}
    }
  },
  "UploadId": 1,
  "UploadPath": "sample string 6",
  "TrackId": 1,
  "EDocumentId": 1,
  "TrafficSource": "sample string 7"
}

application/csp-report

Sample:

{"Id":1,"AuthToken":"sample string 2","EventType":"sample string 3","EventDate":"2025-05-09T13:16:49.0302427+01:00","CampaignId":1,"EmailId":1,"TextMessageId":1,"LandingPageId":1,"IsTest":true,"Contact":{"EncContactId":"sample string 2","ListId":3,"Values":{"sample string 1":{},"sample string 3":{}}},"UploadId":1,"UploadPath":"sample string 6","TrackId":1,"EDocumentId":1,"TrafficSource":"sample string 7"}

application/xml, text/xml

Sample:

<WebhookNotificationDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/W50Common.Model.DTO">
  <AuthToken>sample string 2</AuthToken>
  <CampaignId>1</CampaignId>
  <Contact>
    <EncContactId>sample string 2</EncContactId>
    <Id>1</Id>
    <ListId>3</ListId>
    <Values xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringanyType>
        <d3p1:Key>sample string 1</d3p1:Key>
        <d3p1:Value />
      </d3p1:KeyValueOfstringanyType>
      <d3p1:KeyValueOfstringanyType>
        <d3p1:Key>sample string 3</d3p1:Key>
        <d3p1:Value />
      </d3p1:KeyValueOfstringanyType>
    </Values>
  </Contact>
  <EDocumentId>1</EDocumentId>
  <EmailId>1</EmailId>
  <EventDate xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:DateTime>2025-05-09T12:16:49.0302427Z</d2p1:DateTime>
    <d2p1:OffsetMinutes>60</d2p1:OffsetMinutes>
  </EventDate>
  <EventType>sample string 3</EventType>
  <Id>1</Id>
  <IsTest>true</IsTest>
  <LandingPageId>1</LandingPageId>
  <TextMessageId>1</TextMessageId>
  <TrackId>1</TrackId>
  <TrafficSource>sample string 7</TrafficSource>
  <UploadId>1</UploadId>
  <UploadPath>sample string 6</UploadPath>
</WebhookNotificationDTO>

Response Information

Description

Successful Response - OK (200):

Response Content : HttpResponseMessage

Name	Type	Additional information
Version	Version	None.
Content	HttpContent	None.
StatusCode	HttpStatusCode	None.
ReasonPhrase	string	None.
Headers	Collection of Object	None.
RequestMessage	HttpRequestMessage	None.
IsSuccessStatusCode	boolean	None.

Response Codes:

200 - OK
- The Entity was successfully Inserted
401 - Unauthorized
- Unauthorized request.