GET api/unisender/WebhookEmail

Получение вебхуков по статусу ранее отправленных E-mail писем от Unisender Go

Request Information

URI Parameters

None.

Body Parameters

WebhookEmailRequest
NameDescriptionTypeAdditional information
auth

MD5-хэш строкового тела сообщения, в котором значение auth заменено на api_key пользователя/проекта, чей обработчик вызывается.

string

None.

events_by_user

Массив с одним элементом, содержащий данные о событиях пользователя/проекта.

Collection of EventByUserRow

None.

Request Formats

application/json, text/json

Sample:
{
  "auth": "sample string 1",
  "events_by_user": [
    {
      "user_id": 1,
      "project_id": "sample string 1",
      "project_name": "sample string 2",
      "events": [
        {
          "event_name": "sample string 1",
          "event_data": {
            "job_id": "sample string 1",
            "email": "sample string 2",
            "status": "sample string 3",
            "event_time": "2024-09-08T02:53:11.7033738+03:00",
            "url": "sample string 4",
            "delivery_info": {
              "delivery_status": "sample string 1",
              "destination_response": "sample string 2",
              "user_agent": "sample string 3",
              "ip": "sample string 4"
            },
            "block_time": "2024-09-08T02:53:11.7033738+03:00",
            "block_type": "sample string 5",
            "domain": "sample string 6",
            "SMTP_blocks_count": 1,
            "domain_status": "sample string 7"
          }
        },
        {
          "event_name": "sample string 1",
          "event_data": {
            "job_id": "sample string 1",
            "email": "sample string 2",
            "status": "sample string 3",
            "event_time": "2024-09-08T02:53:11.7033738+03:00",
            "url": "sample string 4",
            "delivery_info": {
              "delivery_status": "sample string 1",
              "destination_response": "sample string 2",
              "user_agent": "sample string 3",
              "ip": "sample string 4"
            },
            "block_time": "2024-09-08T02:53:11.7033738+03:00",
            "block_type": "sample string 5",
            "domain": "sample string 6",
            "SMTP_blocks_count": 1,
            "domain_status": "sample string 7"
          }
        }
      ]
    },
    {
      "user_id": 1,
      "project_id": "sample string 1",
      "project_name": "sample string 2",
      "events": [
        {
          "event_name": "sample string 1",
          "event_data": {
            "job_id": "sample string 1",
            "email": "sample string 2",
            "status": "sample string 3",
            "event_time": "2024-09-08T02:53:11.7033738+03:00",
            "url": "sample string 4",
            "delivery_info": {
              "delivery_status": "sample string 1",
              "destination_response": "sample string 2",
              "user_agent": "sample string 3",
              "ip": "sample string 4"
            },
            "block_time": "2024-09-08T02:53:11.7033738+03:00",
            "block_type": "sample string 5",
            "domain": "sample string 6",
            "SMTP_blocks_count": 1,
            "domain_status": "sample string 7"
          }
        },
        {
          "event_name": "sample string 1",
          "event_data": {
            "job_id": "sample string 1",
            "email": "sample string 2",
            "status": "sample string 3",
            "event_time": "2024-09-08T02:53:11.7033738+03:00",
            "url": "sample string 4",
            "delivery_info": {
              "delivery_status": "sample string 1",
              "destination_response": "sample string 2",
              "user_agent": "sample string 3",
              "ip": "sample string 4"
            },
            "block_time": "2024-09-08T02:53:11.7033738+03:00",
            "block_type": "sample string 5",
            "domain": "sample string 6",
            "SMTP_blocks_count": 1,
            "domain_status": "sample string 7"
          }
        }
      ]
    }
  ]
}

application/xml, text/xml

Sample:
<WebhookEmailRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Request.UnisenderRequest">
  <auth>sample string 1</auth>
  <events_by_user>
    <WebhookEmailRequest.EventByUserRow>
      <events>
        <WebhookEmailRequest.EventByUserRow.EventByUserRowEventRow>
          <event_data>
            <SMTP_blocks_count>1</SMTP_blocks_count>
            <block_time>2024-09-08T02:53:11.7033738+03:00</block_time>
            <block_type>sample string 5</block_type>
            <delivery_info>
              <delivery_status>sample string 1</delivery_status>
              <destination_response>sample string 2</destination_response>
              <ip>sample string 4</ip>
              <user_agent>sample string 3</user_agent>
            </delivery_info>
            <domain>sample string 6</domain>
            <domain_status>sample string 7</domain_status>
            <email>sample string 2</email>
            <event_time>2024-09-08T02:53:11.7033738+03:00</event_time>
            <job_id>sample string 1</job_id>
            <status>sample string 3</status>
            <url>sample string 4</url>
          </event_data>
          <event_name>sample string 1</event_name>
        </WebhookEmailRequest.EventByUserRow.EventByUserRowEventRow>
        <WebhookEmailRequest.EventByUserRow.EventByUserRowEventRow>
          <event_data>
            <SMTP_blocks_count>1</SMTP_blocks_count>
            <block_time>2024-09-08T02:53:11.7033738+03:00</block_time>
            <block_type>sample string 5</block_type>
            <delivery_info>
              <delivery_status>sample string 1</delivery_status>
              <destination_response>sample string 2</destination_response>
              <ip>sample string 4</ip>
              <user_agent>sample string 3</user_agent>
            </delivery_info>
            <domain>sample string 6</domain>
            <domain_status>sample string 7</domain_status>
            <email>sample string 2</email>
            <event_time>2024-09-08T02:53:11.7033738+03:00</event_time>
            <job_id>sample string 1</job_id>
            <status>sample string 3</status>
            <url>sample string 4</url>
          </event_data>
          <event_name>sample string 1</event_name>
        </WebhookEmailRequest.EventByUserRow.EventByUserRowEventRow>
      </events>
      <project_id>sample string 1</project_id>
      <project_name>sample string 2</project_name>
      <user_id>1</user_id>
    </WebhookEmailRequest.EventByUserRow>
    <WebhookEmailRequest.EventByUserRow>
      <events>
        <WebhookEmailRequest.EventByUserRow.EventByUserRowEventRow>
          <event_data>
            <SMTP_blocks_count>1</SMTP_blocks_count>
            <block_time>2024-09-08T02:53:11.7033738+03:00</block_time>
            <block_type>sample string 5</block_type>
            <delivery_info>
              <delivery_status>sample string 1</delivery_status>
              <destination_response>sample string 2</destination_response>
              <ip>sample string 4</ip>
              <user_agent>sample string 3</user_agent>
            </delivery_info>
            <domain>sample string 6</domain>
            <domain_status>sample string 7</domain_status>
            <email>sample string 2</email>
            <event_time>2024-09-08T02:53:11.7033738+03:00</event_time>
            <job_id>sample string 1</job_id>
            <status>sample string 3</status>
            <url>sample string 4</url>
          </event_data>
          <event_name>sample string 1</event_name>
        </WebhookEmailRequest.EventByUserRow.EventByUserRowEventRow>
        <WebhookEmailRequest.EventByUserRow.EventByUserRowEventRow>
          <event_data>
            <SMTP_blocks_count>1</SMTP_blocks_count>
            <block_time>2024-09-08T02:53:11.7033738+03:00</block_time>
            <block_type>sample string 5</block_type>
            <delivery_info>
              <delivery_status>sample string 1</delivery_status>
              <destination_response>sample string 2</destination_response>
              <ip>sample string 4</ip>
              <user_agent>sample string 3</user_agent>
            </delivery_info>
            <domain>sample string 6</domain>
            <domain_status>sample string 7</domain_status>
            <email>sample string 2</email>
            <event_time>2024-09-08T02:53:11.7033738+03:00</event_time>
            <job_id>sample string 1</job_id>
            <status>sample string 3</status>
            <url>sample string 4</url>
          </event_data>
          <event_name>sample string 1</event_name>
        </WebhookEmailRequest.EventByUserRow.EventByUserRowEventRow>
      </events>
      <project_id>sample string 1</project_id>
      <project_name>sample string 2</project_name>
      <user_id>1</user_id>
    </WebhookEmailRequest.EventByUserRow>
  </events_by_user>
</WebhookEmailRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

HttpResponseMessage
NameDescriptionTypeAdditional information
Version

Version

None.

Content

HttpContent

None.

StatusCode

HttpStatusCode

None.

ReasonPhrase

string

None.

Headers

Collection of Object

None.

RequestMessage

HttpRequestMessage

None.

IsSuccessStatusCode

boolean

None.