Path parameters

• endpointId string Required

Responses

• 200 application/json

  Webhook

  Hide response attributes Show response attributes object

  • endpointId string Required

    The unique endpoint ID, for example the integration name. Case sensitive.

  • url string Required

    The URL which this endpoint points to.

  • withBasicAuth boolean

    If basic auth should be used, defaults to false.

    Default value is false.

  • username string

    The username for basic auth.

  • password string

    The password for basic auth.

  • provideAccount boolean

    Whether or not to include account info in the notification.

    Default value is false.

  • expandTransactions boolean

    Whether or not to include transaction lines in the notification.

    Default value is false.

  • expandPayments boolean

    Whether or not to include payment lines in the notification.

    Default value is false.

  • subscribeTo array[object]
    Hide subscribeTo attributes Show subscribeTo attributes object

    • name string

      Events to subscribe to. Order: DELIVERED can be added here.

      The following are always sent:

      • Account: CLOSED and CHECK_WAS_UPDATED.
      • Order: FAILURE, READY_FOR_PICKUP and CANCELLED.
      • Payment: SUCCESS and FAILURE.
    • resource string

      Values are order or payment.

• 404 application/json

  Not Found

  Hide response attributes Show response attributes object

  • timestamp string(date-time)

    The date and time at which the error occurred.

  • status integer

    The HTTP status code associated with the error.

  • error string

    A short description of the HTTP status code meaning.

  • message string

    A human-readable message providing more details about the error.

  • path string

    The request path where the error occurred.