Register a webhook endpoint

Add somewhere to send events. The secret is shown once.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Where we send events, and which ones. IN-302.

url*Url

Must be https. Payloads carry amounts and recipient names. Private and loopback addresses are refused — a webhook URL is fetched by our servers, so one pointing inward is an SSRF.

Lengthlength <= 2048

Example"https://api.example.com/hooks/inversepay"

description?|

For your own reference, shown when listing endpoints. Worth setting once you have more than one.

Example"Production ledger sync"

event_types?array<string>|

Event types to receive. Omit for all of them — a business that has not chosen wants everything, not nothing.

The catalogue:

payout.created
payout.parked
payout.released
payout.approved
payout.processing
payout.completed
payout.failed
payout.returned
payout.rerouted
payout.reconciling
charge.created
charge.succeeded
charge.failed
charge.refunded
charge.partially_refunded
charge.disputed
export.ready

Unknown values are accepted and simply never match, so a typo here is silence rather than an error. Check the spelling against this list if an endpoint is not firing.

Example

[  "payout.completed",  "payout.failed"]

Response Body

`application/json`

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

{  "endpoint": {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "url": "string",    "description": "string",    "event_types": [      "string"    ],    "is_active": true,    "failure_streak": 0,    "last_delivered_at": "2019-08-24T14:15:22Z",    "created_at": "2019-08-24T14:15:22Z"  },  "secret": "string",  "signature_header": "X-InversePay-Signature",  "verification_hint": "Sign the raw request body, not a re-serialised copy: two JSON documents can mean the same thing and differ byte for byte."}

Request Body

Response Body

201application/json

422application/json

`application/json`

`application/json`