Koala Webhooks (2.0.0)
Download OpenAPI specification:Download
Contract Created Webhook
Request Body schema: application/jsonrequired
required | object |
| event required | string Value: "contract.created" |
Responses
Request samples
- Payload
Content type
application/json
{- "data": {
- "contract": {
- "coveredEvent": {
- "arrivalAirport": {
- "city": "string",
- "iata": "str",
- "name": "string"
}, - "arrivalDate": "2023-03-12T02:21:32.000+02:00",
- "departureAirport": {
- "city": "string",
- "iata": "str",
- "name": "string"
}, - "departureDate": "2023-03-12T02:21:32.000+02:00",
- "number": "string"
}, - "createdAt": "2023-03-12T02:21:32.000+02:00",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "maximumExpectedCompensation": {
- "amount": 0,
- "currency": "string"
}, - "priceDetails": {
- "coveredEventPrice": 0,
- "currency": "string",
- "retailPremiumTaxesIncluded": 0
}, - "product": {
- "name": "string",
- "type": "COMPREHENSIVE"
}, - "subscription": {
- "bookingNumber": "string",
- "customer": {
- "email": "user@example.com",
- "firstName": "string",
- "lastName": "string"
}, - "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "subscribedAt": "2023-03-12T02:21:32.000+02:00"
}, - "travelers": [
- {
- "ageRange": "INFANT",
- "countryOfResidence": {
- "id": null,
- "name": "string"
}
}
]
}
}, - "event": "contract.created"
}Claim Updated Webhook
Request Body schema: application/jsonrequired
required | object |
| event required | string Value: "claim.updated" |
Responses
Request samples
- Payload
Content type
application/json
{- "data": {
- "claim": {
- "claimedAt": "2023-03-12T02:21:32.000+02:00",
- "compensation": {
- "amount": 0,
- "currency": "string"
}, - "contract": {
- "coveredEvent": {
- "arrivalAirport": {
- "city": "string",
- "iata": "str",
- "name": "string"
}, - "arrivalDate": "2023-03-12T02:21:32.000+02:00",
- "departureAirport": {
- "city": "string",
- "iata": "str",
- "name": "string"
}, - "departureDate": "2023-03-12T02:21:32.000+02:00",
- "number": "string"
}, - "createdAt": "2023-03-12T02:21:32.000+02:00",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "maximumExpectedCompensation": {
- "amount": 0,
- "currency": "string"
}, - "priceDetails": {
- "coveredEventPrice": 0,
- "currency": "string",
- "retailPremiumTaxesIncluded": 0
}, - "product": {
- "name": "string",
- "type": "COMPREHENSIVE"
}, - "subscription": {
- "bookingNumber": "string",
- "customer": {
- "email": "user@example.com",
- "firstName": "string",
- "lastName": "string"
}, - "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "subscribedAt": "2023-03-12T02:21:32.000+02:00"
}, - "travelers": [
- {
- "ageRange": "INFANT",
- "countryOfResidence": {
- "id": null,
- "name": "string"
}
}
]
}, - "reason": {
- "type": "CANCELATION"
}, - "status": "ACCEPTED"
}
}, - "event": "claim.updated"
}