facilioo Websitefacilioo Platform
API Reference
Contact
Start typing to search…

/api/webhook-registrations

post
https://api.facilioo.de/api/webhook-registrations

Create Webhook Registration

Creates a new webhook registration from the provided data, associating it within the requester's scope.

Module: Webhooks

Returns: Web Hooks → WebhookRegistrationRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Permissions: Create (0)

This will be evaluated against your used access token.
Body Params
int32
required

The ID of the party associated with this webhook registration. That means, only actions made by this particular party in the facilioo will trigger a webhook.

string
required
length between 1 and 2048

The URL where webhook messages should be sent via an HTTP POST request.

enabledEvents
array of objects
required
length ≥ 1

The events that this webhook should be subscribed to.

enabledEvents*
int32
enum
required

Possible values:

  • 1 = Created
  • 2 = Updated
  • 3 = Deleted
  • 4 = ReplaceRelation
  • 5 = AddToRelation
  • 6 = RemoveFromRelation
Allowed:
string
required
length between 1 and 255

The name of the entity associated with this event (e.g., Process, Party, etc.).

boolean
required

If enabled, related messages are assigned to the same group. Messages within a group are always delivered in order, meaning a message will not be sent until the delivery of all earlier messages in the same group has succeeded. (e.g., Property - Entrance - Unit or Conference - Topic, are in the same group)

boolean
required

If enabled, message delivery within a group continues even after a failure. If disabled, a failed message blocks all subsequent messages in the same group until the failed delivery has been resolved.

targetAuthorization
object
required

Represents data for creating authorization for a webhook target.

Headers
string

Language preference header. Allowed languages: German (en-DE).

string
Defaults to 2.0

API version to use (1 or 2) either with trailing .0 or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).

Responses

401

Error: Unauthorized

Updated 7 months ago

Language
Credentials
Bearer
JWT
URL
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 7 months ago