GET api/v2/hooks/history/{eventName}

Get a list of history items with the response matching the output of our webhooks, newest first. History is kept for about seven days, so a request returns up to that much or up to 5000 items, whichever is reached first.

Request Information

URI Parameters

Query String: count={count}

NameDescriptionTypeAdditional information
eventName

Required

 string

None.
count

Optional. How many stored history records to read, newest first. Defaults to 25. Values above 5000 read 5000, however large the number. A value that is not a whole number, or is below 1, is treated as though count was not supplied and reads the default of 25 - it is never an error. You may receive fewer items than you ask for: records this API cannot render in webhook shape are omitted.

 string

None.

Body Parameters

None.

Response Information

Resource Description

[HTTP Status 200 - OK] A set of history items.

Type: HookHistorySet

NameDescriptionTypeAdditional information
HistoryItems

Collection of Object

None.

Response Formats

application/json, text/json

Sample: 
{
  "HistoryItems": [
    {},
    {}
  ]
}

application/xml, text/xml

Sample: 
<HookHistorySet xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <HistoryItems xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:anyType />
    <d2p1:anyType />
  </HistoryItems>
</HookHistorySet>