INinvoiceninja
webhooks

Adds a Webhook

Changed on

Adds an Webhook to a company

post/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

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

Returns the saved Webhook object

idstring

The subscription hashed id

event_idstring

The subscription event id

target_urlstring

The api endpoint

formatstring

JSON or UBL

Example response

{
  "id": "AS3df3A",
  "event_id": "AS3df3A",
  "target_url": "AS3df3A",
  "format": "JSON"
}

Changes

  • 8e82a2bd77e0Revision changes
    • breaking

      the response's body type changed from no type to object for status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • e61df65649e2Revision changes
    • breaking

      the response's body type changed from object to no type for status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status