PUT api/webHook/{id}

Update a web hook

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

Web hook identifier

globally unique identifier

Required

Body Parameters

WebHook to be saved

WebHookSubscription
NameDescriptionTypeAdditional information
ID

globally unique identifier

None.

StoreID

globally unique identifier

None.

URL

string

None.

Secret

globally unique identifier

Required

Description

string

None.

Active

boolean

Required

ExtraEventData

Extra data provided in the Properties field of all events produced by this webhook As an example can be used to provide the destination with info about the source, auth details or a custom json object as examples

string

None.

Events

Collection of WebHookSubscriptionEvent

Relation. This field may not always be loaded or used for updates.

EMCStoreID

The internal StoreID within the tenant's database

integer

Relation. This field may not always be loaded or used for updates.

StoreName

The store name relating to the EMCStoreID

string

Relation. This field may not always be loaded or used for updates.

Request Formats

application/json, text/json

Sample:
{
  "id": "f0e84d46-8d1f-4c7e-a0b6-ce7a7de88bbc",
  "storeID": "45068164-f039-4026-8509-7c266e26f540",
  "url": "sample string 1",
  "secret": "ea2211d6-fe2b-4fcf-adfc-95faaf07cb1b",
  "description": "sample string 2",
  "active": true,
  "extraEventData": "sample string 4",
  "events": [
    {
      "$id": "2",
      "webHookID": "140c0aed-6772-4a08-8ae6-5546e0b5e7c4",
      "webHookEvent": 0,
      "active": true
    },
    {
      "$ref": "2"
    }
  ],
  "emcStoreID": 1,
  "storeName": "sample string 5"
}

application/xml, text/xml

Sample:
<WebHookSubscription xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/EziManager.Models.Tenancies.WebHook">
  <Active>true</Active>
  <Description>sample string 2</Description>
  <EMCStoreID>1</EMCStoreID>
  <Events>
    <WebHookSubscriptionEvent>
      <Active>true</Active>
      <WebHookEvent>ActivateProduct</WebHookEvent>
      <WebHookID>140c0aed-6772-4a08-8ae6-5546e0b5e7c4</WebHookID>
    </WebHookSubscriptionEvent>
    <WebHookSubscriptionEvent>
      <Active>true</Active>
      <WebHookEvent>ActivateProduct</WebHookEvent>
      <WebHookID>140c0aed-6772-4a08-8ae6-5546e0b5e7c4</WebHookID>
    </WebHookSubscriptionEvent>
  </Events>
  <ExtraEventData>sample string 4</ExtraEventData>
  <ID>f0e84d46-8d1f-4c7e-a0b6-ce7a7de88bbc</ID>
  <Secret>ea2211d6-fe2b-4fcf-adfc-95faaf07cb1b</Secret>
  <StoreID>45068164-f039-4026-8509-7c266e26f540</StoreID>
  <StoreName>sample string 5</StoreName>
  <URL>sample string 1</URL>
</WebHookSubscription>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Web hook identifier

globally unique identifier

Response Formats

application/json, text/json

Sample:
"b793189b-2875-4451-b287-21de15fc47c4"

application/xml, text/xml

Sample:
<guid xmlns="http://schemas.microsoft.com/2003/10/Serialization/">b793189b-2875-4451-b287-21de15fc47c4</guid>

application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

Sample:
PK3�Zke�k�5xl/workbook.xml �(����� D�M��(h�&=y鵇ީ,�(`��~~Q�Io���ξ6;?<��nj6Ծ�*Ʃ&$�
7�M;��1I�"NJ�C���IN�xy�����7�?�0y�"(�h�
e���=�bK���9�2{��Dd��[a������1Z��hp���u�,+Q�EE�(2���>`���/PK3�Z����	�[Content_Types].xml �(����J�0�_��*M�D��V�*��d�
�d�k��<�H���V���=
��|�o��|����������+�����7l���e۶~=E�"�zlXO�@Ճ��C�3]HNR~���R��uU�<���������a��36��b7םQ
�1Z�$�8z�R��3
tP��-c�� g����_M��Of���~O�s�T���� ����P<�D��e=1Z��a2�b
��%#H'�2}���e�B)��~j/F�t��PK
3�Zf�`�''_rels/.rels �(�<?xml version="1.0" encoding="utf-8"?><Relationships xmlns="http://schemas.openxmlformats.org/package/2006/relationships"><Relationship Type="http://schemas.openxmlformats.org/officeDocument/2006/relationships/officeDocument" Target="xl/workbook.xml" Id="Rda79fc2c81ff4bb4" /></Relationships>PK3�Z��O<%�xl/worksheets/sheet1.xml �(��Q�n� ��}%m�,��T��j�M;lg�85�Ȑ��? �4i�[~~��Tǻ��4ښo7g`[촽�|��CɏM� ݜ�,��;P͕��A�*0�mpj=��>�t����3����.�
A0H��ң�+���H �d�+�����t`��A_�Ӗ3�T	��aq�b��D��䥫y������_�u��i�o�<��*6�O=-.���7Ό��wѝW5��M�T��]�o˼ଝ�G�W�b�I�g�eS.�R9��(��� �¼s�Ub�������_�-]=PR����PK3�Z���Pxl/_rels/workbook.xml.rels �(���Kn� @��f_���B���$�x0Vl@@��l]�H�BQ*���E7Y����������<O�C�PZ���NI?t�ݬw8ɔ'�}$y�F&%�HiTg���va�)�a�^���r���e�����N�Q�S�m�L�\8F���d0	�)Ez
e��@�{;]�m_�e��J�@���b�L���"v�}�Yɱj��2F��)�K/��党D�j���e�k}U�7��PK3�ZЃc'2E
xl/styles.xml �(��S�j�0��&0���0�^�]v��:��d;��H��Kj�vG�Mz�zOHr�iB8v�F��WEG�?s�Oh�lff�uZМ���ށh�R���6�'��2��������ɳ�UŦ`<Қo���x���8��K�6BC ^�کĖ��B���n��f8����9� ����CUk��#��U�ub��WUB;��k���&�
AR>��� ��im��ΑF���YO��%�}���LJ\in�,���9oy}��y.�$��6��ųNJ�c��T��rĘ)փBR淶�E3ʟ�\��q��PK3�Z6�DS��xl/sharedStrings.xml �(�5��N�0C%�{6Mii��_����Hͤt���p��'۲��;o�N�&��R,K���oz�h	[!����;fQ�J<�*���q��Rv���ˑ�T<����+��ʹM�lrH*���΂:)}����u y'~�Ov�κ�^w]o�\�n킶��n��3��˛���PK-3�Zke�k�5xl/workbook.xmlPK-3�Z����	��[Content_Types].xmlPK-
3�Zf�`�''U_rels/.relsPK-3�Z��O<%��xl/worksheets/sheet1.xmlPK-3�Z���P8xl/_rels/workbook.xml.relsPK-3�ZЃc'2E
}xl/styles.xmlPK-3�Z6�DS���xl/sharedStrings.xmlPK��

application/vnd.ms-excel

Sample:
PK3�Z:*�3�5xl/workbook.xml �(�����0��&�C��B	FR8q���{��4П�5���H�yۙ��v�l��4fD5i_�!؊�
��?:�z�Q�1}/;hM�V����8�x�F�AZ�W�?,op������Ը9bK����'���b"���o�%�~��\A�[8Fɹ�g�J��N��@�EV^��K�w�cd��|PK3�Z����	�[Content_Types].xml �(����J�0�_��*M�D��V�*��d�
�d�k��<�H���V���=
��|�o��|����������+�����7l���e۶~=E�"�zlXO�@Ճ��C�3]HNR~���R��uU�<���������a��36��b7םQ
�1Z�$�8z�R��3
tP��-c�� g����_M��Of���~O�s�T���� ����P<�D��e=1Z��a2�b
��%#H'�2}���e�B)��~j/F�t��PK
3�ZF�U''_rels/.rels �(�<?xml version="1.0" encoding="utf-8"?><Relationships xmlns="http://schemas.openxmlformats.org/package/2006/relationships"><Relationship Type="http://schemas.openxmlformats.org/officeDocument/2006/relationships/officeDocument" Target="xl/workbook.xml" Id="Rca477995dcb04cb3" /></Relationships>PK3�Z��O<%�xl/worksheets/sheet1.xml �(��Q�n� ��}%m�,��T��j�M;lg�85�Ȑ��? �4i�[~~��Tǻ��4ښo7g`[촽�|��CɏM� ݜ�,��;P͕��A�*0�mpj=��>�t����3����.�
A0H��ң�+���H �d�+�����t`��A_�Ӗ3�T	��aq�b��D��䥫y������_�u��i�o�<��*6�O=-.���7Ό��wѝW5��M�T��]�o˼ଝ�G�W�b�I�g�eS.�R9��(��� �¼s�Ub�������_�-]=PR����PK3�Z�D��Pxl/_rels/workbook.xml.rels �(���KN�0@�b͞8�#���ݰa[z��Q۲]�gc���V� �X��j4��'�|���o�D^0��;MUA��� ��]��z���e"�1$RV\`s�&eq���]�g�K�:�i[ל�%��d��7fT���iF���W��"f {�~J�^BS*�'-`ǘf�V]��k�Bo���y�����/d��Z1-Ձw�˛�XQ?�X.�tZ�j-���ʠ�WW�F��b�PK3�ZЃc'2E
xl/styles.xml �(��S�j�0��&0���0�^�]v��:��d;��H��Kj�vG�Mz�zOHr�iB8v�F��WEG�?s�Oh�lff�uZМ���ށh�R���6�'��2��������ɳ�UŦ`<Қo���x���8��K�6BC ^�کĖ��B���n��f8����9� ����CUk��#��U�ub��WUB;��k���&�
AR>��� ��im��ΑF���YO��%�}���LJ\in�,���9oy}��y.�$��6��ųNJ�c��T��rĘ)փBR淶�E3ʟ�\��q��PK3�Z6�DS��xl/sharedStrings.xml �(�5��N�0C%�{6Mii��_����Hͤt���p��'۲��;o�N�&��R,K���oz�h	[!����;fQ�J<�*���q��Rv���ˑ�T<����+��ʹM�lrH*���΂:)}����u y'~�Ov�κ�^w]o�\�n킶��n��3��˛���PK-3�Z:*�3�5xl/workbook.xmlPK-3�Z����	�[Content_Types].xmlPK-
3�ZF�U''V_rels/.relsPK-3�Z��O<%��xl/worksheets/sheet1.xmlPK-3�Z�D��P9xl/_rels/workbook.xml.relsPK-3�ZЃc'2E
~xl/styles.xmlPK-3�Z6�DS���xl/sharedStrings.xmlPK��