POST api/PostmarkDeliveries

Request Information

URI Parameters

None.

Body Parameters

WebhookData
NameDescriptionTypeAdditional information
RecordType

string

None.

ServerID

integer

None.

MessageStream

string

None.

MessageID

string

None.

Recipient

string

None.

Tag

string

None.

DeliveredAt

date

None.

Details

string

None.

Metadata

Dictionary of string [key] and Object [value]

None.

Request Formats

application/json, text/json

Sample:
{
  "RecordType": "sample string 1",
  "ServerID": 2,
  "MessageStream": "sample string 3",
  "MessageID": "sample string 4",
  "Recipient": "sample string 5",
  "Tag": "sample string 6",
  "DeliveredAt": "2025-12-22T13:25:48.5191107+00:00",
  "Details": "sample string 8",
  "Metadata": {
    "sample string 1": {},
    "sample string 3": {}
  }
}

application/xml, text/xml

Sample:
<WebhookData xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PostmarkWebhook.Controllers">
  <DeliveredAt>2025-12-22T13:25:48.5191107+00:00</DeliveredAt>
  <Details>sample string 8</Details>
  <MessageID>sample string 4</MessageID>
  <MessageStream>sample string 3</MessageStream>
  <Metadata xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringanyType>
      <d2p1:Key>sample string 1</d2p1:Key>
      <d2p1:Value />
    </d2p1:KeyValueOfstringanyType>
    <d2p1:KeyValueOfstringanyType>
      <d2p1:Key>sample string 3</d2p1:Key>
      <d2p1:Value />
    </d2p1:KeyValueOfstringanyType>
  </Metadata>
  <Recipient>sample string 5</Recipient>
  <RecordType>sample string 1</RecordType>
  <ServerID>2</ServerID>
  <Tag>sample string 6</Tag>
</WebhookData>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

PostmarkDelivery
NameDescriptionTypeAdditional information
ID

integer

None.

RecordType

string

None.

ServerID

integer

None.

MessageStream

string

None.

MessageID

globally unique identifier

None.

Recipient

string

None.

Tag

string

None.

DeliveredAt

date

None.

Details

string

None.

Metadata

string

None.

example

string

None.

example_2

string

None.

Response Formats

application/json, text/json

Sample:
{
  "ID": 1,
  "RecordType": "sample string 2",
  "ServerID": 1,
  "MessageStream": "sample string 3",
  "MessageID": "0e0388f8-22e9-47b1-927f-37be6f80a959",
  "Recipient": "sample string 4",
  "Tag": "sample string 5",
  "DeliveredAt": "2025-12-22T13:25:48.519463+00:00",
  "Details": "sample string 6",
  "Metadata": "sample string 7",
  "example": "sample string 8",
  "example_2": "sample string 9"
}

application/xml, text/xml

Sample:
<PostmarkDelivery xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PostmarkWebhook">
  <DeliveredAt>2025-12-22T13:25:48.519463+00:00</DeliveredAt>
  <Details>sample string 6</Details>
  <ID>1</ID>
  <MessageID>0e0388f8-22e9-47b1-927f-37be6f80a959</MessageID>
  <MessageStream>sample string 3</MessageStream>
  <Metadata>sample string 7</Metadata>
  <Recipient>sample string 4</Recipient>
  <RecordType>sample string 2</RecordType>
  <ServerID>1</ServerID>
  <Tag>sample string 5</Tag>
  <example>sample string 8</example>
  <example_2>sample string 9</example_2>
</PostmarkDelivery>