Create Webhook

Register an HTTPS endpoint that Recommand posts events to as they happen, so you do not have to poll the documents endpoints.

POST

/api/v1/webhooks

Register an HTTPS endpoint that Recommand posts events to as they happen, so you do not have to poll the documents endpoints. It receives every peppol event for the team: document.received, document.sent, document.delivery_status_changed, document.label.assigned, document.label.unassigned, document.reporting_status_changed and company.verification. There is no per-event subscription. Set a secret to have every delivery signed, and check that signature before acting on a request. Deliveries are retried for a while on a timeout or a 5xx; any other response is treated as final.

Authorization

AuthorizationBasic <token>

Basic API key authentication. Create a new API key and secret in the Recommand dashboard.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

url*string

The HTTPS endpoint to deliver events to. Each delivery is a JSON POST carrying the event, with an X-Idempotency-Key header you can use to discard a redelivery. Answer with a 2xx once you have accepted the event; a timeout or a 5xx is retried, anything else is not.

Formaturi

Example"https://example.com/hooks/recommand"

companyId?|

Limit the webhook to one company's events. Leave it out to receive the events of every company in the team.

Example"c_01JQZ8X0M4T7RB6K9V2NDHW3PA"

secret?|

Optional secret used to send X-Signature: sha256=, computed with HMAC-SHA256 over the raw request body. Leave it out to have deliveries sent unsigned.

Length1 <= length

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/webhooks" \  -H "Content-Type: application/json" \  -d '{    "url": "https://example.com/hooks/recommand"  }'

{  "success": true,  "webhook": {    "id": "wh_01JQZ8X0M4T7RB6K9V2NDHW3PA",    "teamId": "team_01JQZ8X0M4T7RB6K9V2NDHW3PA",    "companyId": null,    "url": "https://example.com/hooks/recommand",    "secret": "string",    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z"  }}

AuthorizationCopy Anchor Link

Request BodyCopy Anchor Link

Response BodyCopy Anchor Link

200application/json

400application/json

500application/json

Authorization

Request Body

Response Body

`application/json`

`application/json`

`application/json`