INinvoiceninja
webhooks

Gets a list of Webhooks

Changed on

Lists Webhooks, search and filters allow fine grained lists to be generated. * * Query parameters can be added to performed more fine grained filtering of the Webhooks, these are handled by the WebhookFilters class which defines the methods available

get/api/v1/webhooks

Request

Query parameters

includestring
Example:first_load

Includes child relationships in the response, format is comma separated. Check each model for the list of associated includes

indexstring
Example:user

Replaces the default response index from data to a user specific string

ie.

  ?index=new_index

response is wrapped

  {
    'new_index' : [
      .....  
    ]
  }
per_pageinteger
Example:20

The number of records to return for each request, default is 20

pageinteger
Example:1

The page number to return for this request (when performing pagination), default is 1

sortstring[]

Order the list by choosing a column and direction. Each value uses the form column|asc or column|desc.

Single sort — for example sort=created_at|desc.

Multiple sorts — for example
sort[]=id|desc&sort[]=created_at|asc.

Only webhooks table columns apply. Unsupported keys are ignored.

[
  "created_at|desc"
]

Headers

X-API-TOKENstring required
Example:TOKEN

The API token to be used for authentication

X-Requested-Withstring required
Example:XMLHttpRequest

Used to send the XMLHttpRequest header

Response

A list of Webhooks

Example response

{
  "data": [
    {
      "id": "AS3df3A",
      "event_id": "AS3df3A",
      "target_url": "AS3df3A",
      "format": "JSON"
    }
  ],
  "meta": {
    "pagination": {
      "total": 1,
      "count": 1,
      "per_page": 1,
      "current_page": 1,
      "total_pages": 1
    }
  }
}

Changes