ASP.NET Web API Help Page

POST vendors/docmagic/webhook?hmacSig={hmacSig}

Receives a notification from DocMagic.

Request Information

URI Parameters

Name	Description	Type	Additional information
hmacSig	the HMAC signature.	string	None.

Body Parameters

notification message from DocMagic.

DocMagicNotification

Name	Type	Additional information
AccountIdentifier	string	None.
ApplicationEventType	string	None.
ApplicationName	string	None.
EventInformation	EventInformation	None.
NotificationDateTime	date	None.
NotificationIdentifier	string	None.

Request Formats

application/json, text/json

Sample:

{
  "AccountIdentifier": "sample String 1",
  "ApplicationEventType": "sample String 2",
  "ApplicationName": "sample String 3",
  "EventInformation": {
    "AccountId": "sample String 1",
    "Code": "sample String 2",
    "CreateDate": "2025-04-26T01:07:46.7121455Z",
    "DataSources": [
      {
        "DataSourceName": "sample String 1",
        "DataSourceTransactionIdentifier": "sample String 2"
      },
      {
        "DataSourceName": "sample String 1",
        "DataSourceTransactionIdentifier": "sample String 2"
      }
    ],
    "EventType": "sample String 3",
    "IPAddress": "sample String 4",
    "Note": "sample String 5",
    "OriginatorReferenceId": "sample String 6",
    "PackageId": "sample String 7",
    "PackageType": "sample String 8",
    "ParticipantId": "sample String 9",
    "ParticipantReferenceIdentifier": "sample String 10",
    "SignatureEnabled": true,
    "TransactionId": "sample String 11",
    "UserName": "sample String 12"
  },
  "NotificationDateTime": "2025-04-26T01:07:46.7277474Z",
  "NotificationIdentifier": "sample String 4"
}

text/html

Sample:

{"AccountIdentifier":"sample String 1","ApplicationEventType":"sample String 2","ApplicationName":"sample String 3","EventInformation":{"AccountId":"sample String 1","Code":"sample String 2","CreateDate":"2025-04-26T01:07:46.7121455Z","DataSources":[{"DataSourceName":"sample String 1","DataSourceTransactionIdentifier":"sample String 2"},{"DataSourceName":"sample String 1","DataSourceTransactionIdentifier":"sample String 2"}],"EventType":"sample String 3","IPAddress":"sample String 4","Note":"sample String 5","OriginatorReferenceId":"sample String 6","PackageId":"sample String 7","PackageType":"sample String 8","ParticipantId":"sample String 9","ParticipantReferenceIdentifier":"sample String 10","SignatureEnabled":true,"TransactionId":"sample String 11","UserName":"sample String 12"},"NotificationDateTime":"2025-04-26T01:07:46.7277474Z","NotificationIdentifier":"sample String 4"}

application/xml, text/xml

Sample:

<DocMagicNotification xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <AccountIdentifier>sample String 1</AccountIdentifier>
  <ApplicationEventType>sample String 2</ApplicationEventType>
  <ApplicationName>sample String 3</ApplicationName>
  <EventInformation>
    <AccountId>sample String 1</AccountId>
    <Code>sample String 2</Code>
    <CreateDate>2025-04-26T01:07:46.7121455Z</CreateDate>
    <DataSources>
      <Datasource>
        <DataSourceName>sample String 1</DataSourceName>
        <DataSourceTransactionIdentifier>sample String 2</DataSourceTransactionIdentifier>
      </Datasource>
      <Datasource>
        <DataSourceName>sample String 1</DataSourceName>
        <DataSourceTransactionIdentifier>sample String 2</DataSourceTransactionIdentifier>
      </Datasource>
    </DataSources>
    <EventType>sample String 3</EventType>
    <IPAddress>sample String 4</IPAddress>
    <Note>sample String 5</Note>
    <OriginatorReferenceId>sample String 6</OriginatorReferenceId>
    <PackageId>sample String 7</PackageId>
    <PackageType>sample String 8</PackageType>
    <ParticipantId>sample String 9</ParticipantId>
    <ParticipantReferenceIdentifier>sample String 10</ParticipantReferenceIdentifier>
    <SignatureEnabled>true</SignatureEnabled>
    <TransactionId>sample String 11</TransactionId>
    <UserName>sample String 12</UserName>
  </EventInformation>
  <NotificationDateTime>2025-04-26T01:07:46.7277474Z</NotificationDateTime>
  <NotificationIdentifier>sample String 4</NotificationIdentifier>
</DocMagicNotification>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

The response.

StatusCodeResult

Name	Description	Type	Additional information
StatusCode		HttpStatusCode	None.
Request		HttpRequestMessage	None.

Response Formats

application/json, text/json, text/html

Sample:

Sample not available.