POST api/NYMCARDService/CreateWebhook

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
endpoint	string	None.
events	Collection of string	None.
config	Config	None.

Request Formats

application/json, text/json

Sample:

{
  "endpoint": "sample string 1",
  "events": [
    "sample string 1",
    "sample string 2"
  ],
  "config": {
    "basic_auth_username": "sample string 1",
    "basic_auth_password": "sample string 2",
    "custom_headers": [
      {
        "header_name": "sample string 1",
        "header_value": "sample string 2"
      },
      {
        "header_name": "sample string 1",
        "header_value": "sample string 2"
      }
    ],
    "created": "2024-09-19T04:15:42.1367194+00:00",
    "modified": "2024-09-19T04:15:42.1367194+00:00"
  }
}

application/xml, text/xml

Sample:

<WebhookInput xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Bankiom.NYMCARD.Service.Models">
  <config>
    <basic_auth_password>sample string 2</basic_auth_password>
    <basic_auth_username>sample string 1</basic_auth_username>
    <created>2024-09-19T04:15:42.1367194+00:00</created>
    <custom_headers>
      <CustomHeader>
        <header_name>sample string 1</header_name>
        <header_value>sample string 2</header_value>
      </CustomHeader>
      <CustomHeader>
        <header_name>sample string 1</header_name>
        <header_value>sample string 2</header_value>
      </CustomHeader>
    </custom_headers>
    <modified>2024-09-19T04:15:42.1367194+00:00</modified>
  </config>
  <endpoint>sample string 1</endpoint>
  <events xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </events>
</WebhookInput>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

BaseResponseOfWebhook

Name	Type	Additional information
IsSuccess	boolean	None.
Data	Webhook	None.
ErrorMessage	string	None.

Response Formats

application/json, text/json

Sample:

{
  "IsSuccess": true,
  "Data": {
    "endpoint": "sample string 1",
    "id": "sample string 2",
    "active": true,
    "events": [
      "sample string 1",
      "sample string 2"
    ],
    "config": {
      "basic_auth_username": "sample string 1",
      "basic_auth_password": "sample string 2",
      "custom_headers": [
        {
          "header_name": "sample string 1",
          "header_value": "sample string 2"
        },
        {
          "header_name": "sample string 1",
          "header_value": "sample string 2"
        }
      ],
      "created": "2024-09-19T04:15:42.1523897+00:00",
      "modified": "2024-09-19T04:15:42.1523897+00:00"
    },
    "created": "2024-09-19T04:15:42.1523897+00:00",
    "modified": "2024-09-19T04:15:42.1523897+00:00"
  },
  "ErrorMessage": "sample string 2"
}

application/xml, text/xml

Sample:

<BaseResponseOfWebhookzwF0ve9J xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Bankiom.NYMCARD.Service.Models">
  <Data>
    <active>true</active>
    <config>
      <basic_auth_password>sample string 2</basic_auth_password>
      <basic_auth_username>sample string 1</basic_auth_username>
      <created>2024-09-19T04:15:42.1523897+00:00</created>
      <custom_headers>
        <CustomHeader>
          <header_name>sample string 1</header_name>
          <header_value>sample string 2</header_value>
        </CustomHeader>
        <CustomHeader>
          <header_name>sample string 1</header_name>
          <header_value>sample string 2</header_value>
        </CustomHeader>
      </custom_headers>
      <modified>2024-09-19T04:15:42.1523897+00:00</modified>
    </config>
    <created>2024-09-19T04:15:42.1523897+00:00</created>
    <endpoint>sample string 1</endpoint>
    <events xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </events>
    <id>sample string 2</id>
    <modified>2024-09-19T04:15:42.1523897+00:00</modified>
  </Data>
  <ErrorMessage>sample string 2</ErrorMessage>
  <IsSuccess>true</IsSuccess>
</BaseResponseOfWebhookzwF0ve9J>