Get Webhook List

Retrieves a list of webhooks based on the provided query string

GET https://my.mattero.com.au/public/api/v1/webhooks

Parameters

Name Location Type Description
search Query string:optional General search to filter webhooks by
sortBy Query string:optional The property name to sort by
sortDirection Query string:optional The direction to sort the results by, expected values are [Ascending | Descending]
pageIndex Query number:optional The index of the page to resolve, page numbers start at 0
pageSize Query number:optional The maximum number of results to include on a single page, must be between or equal to 1 and 250.
pageIndexForId Query number:optional The resolves the page index for the entity with the associated id

Response

{
  "totalRecords": 7,
  "pageIndex": 0,
  "records": [
      {
          "eventName": "CreateMatterEvent",
          "callbackUrl": "https://fakeapi.com/webhook",
          "id": "3-A"
      },
      {
          "eventName": "CreateMatterEvent",
          "callbackUrl": "https://anotherwebsite.com/callback",
          "id": "38-A"
      },
      {
          "eventName": "CreateContactEvent",
          "callbackUrl": "https://fakeapi.com/webhook",
          "id": "4-A"
      },
      {
          "eventName": "UpdateContactEvent",
          "callbackUrl": "https://fakeapi.com/webhook",
          "id": "35-A"
      },
      {
          "eventName": "UpdateMatterEvent",
          "callbackUrl": "https://fakeapi.com/webhook",
          "id": "36-A"
      },
      {
          "eventName": "CreateTaskEvent",
          "callbackUrl": "https://fakeapi.com/webhook",
          "id": "37-A"
      }
  ]
}

WebhookListResponse object

Name Type Description
totalRecords integer The total records found on the server that match the query parameters.
pageIndex integer The index of the page found.
records Webhook[] An array of tasks found in the request.

Webhook object

Name Type Description
id string The unique identifier associated with a webhook.
eventName string Event name the webhook subscribed to, supported values are [ CreateContactEvent | UpdateContactEvent | CreateMatterEvent | UpdateMatterEvent | CreateTaskEvent | UpdateTaskEvent]
callbackUrl string The RESTful callback to be invoked when the event is trigger, this callback must accept a POST request.

Status Codes

Code Summary Description
200 Ok The request was successful with a body in the response.
400 Bad Request The request failed validation checks.
401 Unauthorized Failed authentication check.