Webhooks
Partners

Get a list of events sent to a webhook endpoint.

Changed on

Get all webhook events for a given endpoint created since a given date.

Query parameters:

  • createdSince (required, format is yyyy-MM-dd)
  • pageIndex (required, integer, first page is 0)
  • pageSize (required, integer, max size is 1000)

Response:

  • Array of events created since the given date

Notes:

  • Results are paginated. The maximum page size is 1000.
get/api/partners/orgs/{orgId}/webhook-endpoints/{webhookEndpointId}/events

Request

  • Base URL
    https://api.mobilecoach.org (the document declares no server; this is the origin it was published from)
  • URL
    https://api.mobilecoach.org/api/partners/orgs/{orgId}/webhook-endpoints/{webhookEndpointId}/events
  • Auth
    AuthToken (a scheme the document does not define)

Path parameters

orgIdinteger required
webhookEndpointIdinteger required

Query parameters

createdSincestring required

yyyy-MM-dd

pageIndexinteger

Page Index (starts at zero)

pageSizeinteger

Page Size (max 1000)

Response

OK

successboolean
errorstring
totalItemCountinteger
totalPagesinteger
itemCountinteger
isFirstboolean
isLastboolean
hasNextboolean
hasPreviousboolean

Changes

  • 870f28ba2607Revision changes
    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status