Skip to main content
POST
Create a webhook endpoint
Preview. A contract we are building with design partners. It is not callable yet, and fields can still change. See Availability.
The response to the first endpoint you create carries your signing_secret; it is shown once. See Webhooks for signature verification.

Authorizations

Authorization
string
header
required

Your partner secret key, mk_live_… for real companies or mk_test_… for test companies. Keep it on your servers. See Authentication.

Headers

Idempotency-Key
string

A unique key, such as a UUID, that makes a retried create safe. Reusing a key with a different body is refused.

Maximum string length: 255

Body

application/json
url
string<uri>
required

An absolute https URL that resolves to public addresses.

Maximum string length: 2048
event_types
enum<string>[]
required
Minimum array length: 1
Available options:
company.onboarding_completed,
mandate.signed,
mandate.activated,
mandate.rejected,
mandate.revoked,
invoice.issued,
invoice.registered,
invoice.registration_failed,
invoice.sent,
invoice.paid,
document.processed,
bank_movement.reconciliation_proposed,
tax_obligation.due_soon,
tax_return.calculated,
tax_return.approved,
tax_return.filed,
case.updated,
case.information_requested,
case.approval_requested,
case.completed,
notification.received,
certificate.issued,
payroll_run.validated,
affiliation.accepted,
affiliation.rejected,
contribution_settlement.available,
contribution_settlement.discrepancy,
contribution_settlement.paid,
employment_notification.registered,
employment_notification.rejected
description
string
Maximum string length: 500
enabled
boolean
default:true

Response

The endpoint, and the signing secret when this is your first endpoint.

endpoint
object
required
signing_secret
string

whsec_ followed by 64 hex characters. Returned once.