Get webhook

Get webhook

import requests

url = "https://api.paywise.de/partner/v2/webhooks/{id}/"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.paywise.de/partner/v2/webhooks/{id}/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

using RestSharp;


var options = new RestClientOptions("https://api.paywise.de/partner/v2/webhooks/{id}/");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
var response = await client.GetAsync(request);

Console.WriteLine("{0}", response.Content);

{
  "auto_disabled": true,
  "consecutive_failures": 123,
  "created_at": "2023-11-07T05:31:56Z",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "last_failure_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "url": "<string>",
  "companies": "<unknown>",
  "description": "<string>",
  "enabled": true,
  "events": [
    "*"
  ],
  "max_consecutive_failures": 500
}

{
  "code": "not_authenticated",
  "detail": "Authentication credentials were not provided."
}

{
  "code": "<string>",
  "detail": "<string>",
  "errors": [
    {
      "code": "<string>",
      "field": "<string>",
      "message": "<string>"
    }
  ]
}

{
  "code": "not_found",
  "detail": "The requested resource was not found."
}

{
  "code": "<string>",
  "detail": "<string>",
  "errors": [
    {
      "code": "<string>",
      "field": "<string>",
      "message": "<string>"
    }
  ]
}

{
  "code": "<string>",
  "detail": "<string>",
  "errors": [
    {
      "code": "<string>",
      "field": "<string>",
      "message": "<string>"
    }
  ]
}

GET

partner

webhooks

{id}

Get webhook

import requests

url = "https://api.paywise.de/partner/v2/webhooks/{id}/"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.paywise.de/partner/v2/webhooks/{id}/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

using RestSharp;


var options = new RestClientOptions("https://api.paywise.de/partner/v2/webhooks/{id}/");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
var response = await client.GetAsync(request);

Console.WriteLine("{0}", response.Content);

{
  "auto_disabled": true,
  "consecutive_failures": 123,
  "created_at": "2023-11-07T05:31:56Z",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "last_failure_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "url": "<string>",
  "companies": "<unknown>",
  "description": "<string>",
  "enabled": true,
  "events": [
    "*"
  ],
  "max_consecutive_failures": 500
}

{
  "code": "not_authenticated",
  "detail": "Authentication credentials were not provided."
}

{
  "code": "<string>",
  "detail": "<string>",
  "errors": [
    {
      "code": "<string>",
      "field": "<string>",
      "message": "<string>"
    }
  ]
}

{
  "code": "not_found",
  "detail": "The requested resource was not found."
}

{
  "code": "<string>",
  "detail": "<string>",
  "errors": [
    {
      "code": "<string>",
      "field": "<string>",
      "message": "<string>"
    }
  ]
}

{
  "code": "<string>",
  "detail": "<string>",
  "errors": [
    {
      "code": "<string>",
      "field": "<string>",
      "message": "<string>"
    }
  ]
}

Authorizations

Authorization

string

header

required

Partner API Bearer key: Authorization: Bearer <key>. Keys are created only through authorized portal or staff flows.

Headers

If-None-Match

string

Return 304 with an empty body when the current ETag matches one of the supplied validators (or *).

Path Parameters

string<uuid>

required

UUID of the webhook subscription in this request.

Response

Resource representation with a native UUID id.

auto_disabled

boolean

required

read-only

true when the endpoint was disabled automatically after reaching max_consecutive_failures; re-enable it with enabled: true once the destination is fixed. Auto-disabled endpoints do not count toward the endpoint limit.

consecutive_failures

integer

required

read-only

Consecutive terminal delivery failures counted against this endpoint. A successful delivery resets the counter to zero.

created_at

string<date-time>

required

read-only

Time at which the webhook subscription was created.

string<uuid>

required

read-only

Stable identifier for this resource.

last_failure_at

string<date-time> | null

required

read-only

Time of the latest counted terminal delivery failure since the last success; null before any failure or after a successful delivery.

updated_at

string<date-time>

required

read-only

Time at which the webhook subscription was last updated.

url

string<uri>

required

Publicly reachable HTTPS URL that receives webhook POST deliveries. The URL must be unique among this partner's v2 webhook endpoints.

Maximum string length: 2048

companies

any | null

Company selector for case and Mahnservice events: the string "*" includes every company with available partner case access, including companies added later; otherwise a JSON array of 1–500 accessible company UUIDs. Null makes the subscription lifecycle-only: no company case or Mahnservice events are delivered. Required for explicit case event types; omitted on PATCH preserves the selector.

description

string

Optional single-line label for this webhook.

Maximum string length: 255

enabled

boolean

Whether deliveries are attempted. Re-enabling an endpoint resets its consecutive failure counter. Auto-disabled endpoints do not count toward the endpoint limit, so re-enabling one requires a free slot; otherwise the request returns 409 webhook_limit_reached.

events

enum<string>[]

Event types this endpoint receives. Use ["*"] alone to subscribe to all event types, with case events delivered only when a companies selector is configured. Explicit case event types require companies.

* - *
company.created - company.created
company.case_submission_readiness.changed - company.case_submission_readiness.changed
company.access.confirmed - company.access.confirmed
company.access.revoked - company.access.revoked
company.access.restored - company.access.restored
company.user.added - company.user.added
company.user.revoked - company.user.revoked
company.user.activated - company.user.activated
company.user.invite_expired - company.user.invite_expired
order.submitted - order.submitted
order.withdrawn - order.withdrawn
order.rejected - order.rejected
order.accepted - order.accepted
order.expired - order.expired
mandate.created - mandate.created
mandate.state.changed - mandate.state.changed
mandate.status_update.published - mandate.status_update.published
mandate.balance_updated - mandate.balance_updated
order.message.created - order.message.created
mandate.message.created - mandate.message.created
request_to_client.created - request_to_client.created
request_to_client.answered - request_to_client.answered
payment.reported - payment.reported
statement.published - statement.published
statement.cancelled - statement.cancelled
single_mandate_statement.published - single_mandate_statement.published
single_mandate_statement.cancelled - single_mandate_statement.cancelled
mandate.correspondence.published - mandate.correspondence.published
invoice.created - invoice.created
invoice.paid - invoice.paid
invoice.cancelled - invoice.cancelled
invoice.written_off - invoice.written_off
invoice.reopened - invoice.reopened
dunning.level_advanced - dunning.level_advanced
dunning.handed_to_collection - dunning.handed_to_collection

Available options:

*,

company.created,

company.case_submission_readiness.changed,

company.access.confirmed,

company.access.revoked,

company.access.restored,

company.user.added,

company.user.revoked,

company.user.activated,

company.user.invite_expired,

order.submitted,

order.withdrawn,

order.rejected,

order.accepted,

order.expired,

mandate.created,

mandate.state.changed,

mandate.status_update.published,

mandate.balance_updated,

order.message.created,

mandate.message.created,

request_to_client.created,

request_to_client.answered,

payment.reported,

statement.published,

statement.cancelled,

single_mandate_statement.published,

single_mandate_statement.cancelled,

mandate.correspondence.published,

invoice.created,

invoice.paid,

invoice.cancelled,

invoice.written_off,

invoice.reopened,

dunning.level_advanced,

dunning.handed_to_collection

max_consecutive_failures

integer

Automatically disables the endpoint when this many consecutive deliveries reach terminal failure. Retry attempts within one delivery do not each count. Raising it above the failure count of an automatically disabled endpoint makes that endpoint count toward the endpoint limit again and requires a free slot.

Required range: 1 <= x <= 1000

Start here

API essentials

Case Management API

Partner API

Mahnservice API

SDKs

Integrations

Legacy APIs (v1)

Authorizations

Headers

Path Parameters

Response