GuidesAPI ReferenceSwagger
Guides

Schedaero Webhooks

This page contains information and instructions about specific events related to Schedaero.

Suggest Edits

Contacts

EventType: SchedAeroContacts

Notifies your application when any contact is created, or when any of the api-visible fields on the contact are modified.

Contact details can be retrieved by using the:

GET /contacts/people/{contactid}

or

GET /contacts/companies/{contactid}

operatrions, as indicated in the webhook payload.

POST /webhooks/settings

{
	"targetURI": "https://myapplication.com/notifications",
	"displayName": "Schedaero contact changes",
	"active": true,
	"clientIdentifier": "myapplication",
	"clientSecret": "secret",
	"clientAuthenticationType": "BASIC",
	"eventTypes": [
		"SchedAeroContacts"
	]
}

{
	"type": "SchedAeroContacts",
	"id": "contact-123456789",
	"href": "https://sandbox-schedaero.avinode.com/api/contacts/people/contact-123456789"
}

Passengers

EventType: SchedAeroPassengers

Notifies your application when a passenger is assigned to a flight, or when any of the api-visible fields on a an existing passenger are modified.

Passenger details can be retrieved by using the:

GET /passengers/{passengerid}

operation, as indicated in the webhook payload.

POST /webhooks/settings

{
                "targetURI": "https://myapplication.com/notifications",
                "displayName": "Schedaero passenger changes",
                "active": true,
                "clientIdentifier": "myapplication",
                "clientSecret": "secret",
                "clientAuthenticationType": "BASIC",
                "eventTypes": [
                                "SchedAeroPassengers"
                ]
}

{
                "type": "SchedAeroPassengers",
                "id": "schedaero-passenger-123456789-123456789",
                "href": "https://sandbox-schedaero.avinode.com/api/passengers/schedaero-passenger-123456789-123456789"
}

Logistics

EventType: SchedAeroLogistics

Notifies your application when a service on a flight leg is created or changed.

Logistic Details can be retrieved by using the:

GET /logistics/{serviceid}

operation, as indicated in the webhook payload.

POST /webhooks/settings

{
"targetURI": "https://myapplication.com/notifications",
"displayName": "Schedaero logistics changes",
"active": true,
"clientIdentifier": "myapplication",
"clientSecret": "secret",
"clientAuthenticationType": "BASIC",
"eventTypes": [
"SchedAeroLogistics"
]

{
    "type": "SchedAeroLogistics",
    "id": "schedaero-logistics-123456789",
    "href": "https://sandbox-schedaero.avinode.com/api/logistics/schedaero-logistics-123456789"
}

Crew Assignment

EventType: SchedAeroCrewAssignments

Notifies your application when a crew member is assigned to a flight, or when any of the api-visible fields on an existing crew assignment are modified.

Crew assignment details can be retrieved by using the:

GET /crewassignments/{assignmentid}

operation, as indicated in the webhook payload.

POST /webhooks/settings

{
	"targetURI": "https://myapplication.com/notifications",
	"displayName": "Schedaero crew changes",
	"active": true,
	"clientIdentifier": "myapplication",
	"clientSecret": "secret",
	"clientAuthenticationType": "BASIC",
	"eventTypes": [
		"SchedAeroCrewAssignments"
	]
}

{
	"type": "SchedAeroCrewAssignments",
	"id": "schedaero-crew-123456789",
	"href": "https://sandbox-schedaero.avinode.com/api/crewassignments/schedaero-crew-123456789"
}

Flight Legs

EventType: SchedAeroFlightLegs

Notifies your application when any flight leg is created, released or cancelled, or when any of the api-visible fields on the leg are modified.

Leg details can be retrieved by using the:

GET /flightlegs/{legid}

operation, as indicated in the webhook payload.

🚧

Please note

The flight legs webhook does not notify when the associated trip changes; use the scheduled trips webhook to receive notifications when a trip changes.

POST /webhooks/settings

{
	"targetURI": "https://myapplication.com/notifications",
	"displayName": "Schedaero flight changes",
	"active": true,
	"clientIdentifier": "myapplication",
	"clientSecret": "secret",
	"clientAuthenticationType": "BASIC",
	"eventTypes": [
		"SchedAeroFlightLegs"
	]
}

{
	"type": "SchedAeroFlightLegs",
	"id": "schedaero-flightleg-123456789",
	"href": "https://sandbox-schedaero.avinode.com/api/flightlegs/schedaero-flightleg-123456789"
}

Own Quote Replies

EventType: SchedAeroOwnQuoteReplies

Notifies your application when a quote originally created in SchedAero is sent to the trip’s requester.

Quote details can be retrieved by using the:

GET /quotes/{quoteid}

operation, as indicated in the webhook payload.

This webhook is intended to be used together with the Avinode Trip Messages – Mine webhook. Quotes sent in response to Avinode requests will notify the Avinode webhook, while quotes created in SchedAero will notify through this webhook. If your application subscribes to both, you will receive all quotes sent from SchedAero.

POST /webhooks/settings

{
	"targetURI": "https://myapplication.com/notifications",
	"displayName": "Schedaero own quote sent",
	"active": true,
	"clientIdentifier": "myapplication",
	"clientSecret": "secret",
	"clientAuthenticationType": "BASIC",
	"eventTypes": [
		"SchedAeroOwnQuoteReplies"
	]
}

{
	"type": "SchedAeroOwnQuoteReplies",
	"id": "schedaero-quote-123456789",
	"href": "https://sandbox-schedaero.avinode.com/api/quotes/schedaero-quote-123456789"
}

Quoted Trips

EventType: SchedAeroQuotedTrips

Notifies your application when a quoted trip is created, or when any of the api-visible fields on the trip are modified.

Trip details can be retrieved by using the:

GET /trips/{tripid}

operation, as indicated in the webhook payload.

Note that the quoted trips webhook notifies only when a trip-level field changes. Use the quotes webhook to receive notification when a quote changes.

POST /webhooks/settings

{
	"targetURI": "https://myapplication.com/notifications",
	"displayName": "Schedaero quoted trip changes",
	"active": true,
	"clientIdentifier": "myapplication",
	"clientSecret": "secret",
	"clientAuthenticationType": "BASIC",
	"eventTypes": [
		"SchedAeroQuotedTrips"
	]
}

{
	"type": "SchedAeroQuotedTrips",
	"id": "schedaero-trip-123456789",
	"href": "https://sandbox-schedaero.avinode.com/api/trips/schedaero-trip-123456789"
}

Quotes

EventType: SchedAeroQuotes

Notifies your application when a quote is created or modified.

Quote details can be retrieved by using the:

GET /quotes/{quoteid}

operation, as indicated in the webhook payload.

Note that the quotes webhook notifies only when the quote or its itinerary changes. Use the quoted trips webhook to receive notification when a trip level field changes.

POST /webhooks/settings

{
	"targetURI": "https://myapplication.com/notifications",
	"displayName": "Schedaero quote changes",
	"active": true,
	"clientIdentifier": "myapplication",
	"clientSecret": "secret",
	"clientAuthenticationType": "BASIC",
	"eventTypes": [
		"SchedAeroQuotes"
	]
}

{
	"type": "SchedAeroQuotes",
	"id": "schedaero-quote-123456789",
	"href": "https://sandbox-schedaero.avinode.com/api/quotes/schedaero-quote-123456789"
}

Scheduled Trips

EventType: SchedAeroScheduledTrips

Notifies your application when a scheduled trip is created or cancelled, or when any of the api-visible fields on the trip are modified.

Trip details can be retrieved by using the:

GET /trips/{tripid}

operation, as indicated in the webhook payload.

Note that the scheduled trips webhook does not notify when an itinerary leg changes; use the flight legs webhook to receive notification when a leg changes.

POST /webhooks/settings

{
	"targetURI": "https://myapplication.com/notifications",
	"displayName": "Schedaero scheduled trip changes",
	"active": true,
	"clientIdentifier": "myapplication",
	"clientSecret": "secret",
	"clientAuthenticationType": "BASIC",
	"eventTypes": [
		"SchedAeroScheduledTrips"
	]
}

{
	"type": "SchedAeroScheduledTrips",
	"id": "schedaero-trip-123456789",
	"href": "https://sandbox-schedaero.avinode.com/api/trips/schedaero-trip-123456789"
}

Invoices

EventType: SchedAeroInvoices

Notifies your application when an Invoice is Created or Updated

Invoice details can be retrieved by using the:

GET /invoices/{invoiceid}

operation, as indicated in the webhook payload.

POST /webhooks/settings

{
	"targetURI": "https://myapplication.com/notifications",
	"displayName": "Schedaero invoice changes",
	"active": true,
	"clientIdentifier": "myapplication",
	"clientSecret": "secret",
	"clientAuthenticationType": "BASIC",
	"eventTypes": [
		"SchedAeroInvoices"
	]
}

{
	"id": "schedaero-invoice-123456789",
	"href": "https://sandbox-schedaero.avinode.com/api/invoices/schedaero-invoice-123456789",
  "type": "schedaero-invoice"
}

Duty Logs

EventType: SchedAeroDutyLogs

Notifies your application when any Duty Log is created or edited

Duty Log details can be retrieved by using the:

GET /v2/DutyLogs/{dutylogId}

operation, as indicated in the webhook payload.

POST /webhooks/settings

{
	"targetURI": "https://myapplication.com/notifications",
	"displayName": "Schedaero Duty Log changes",
	"active": true,
	"clientIdentifier": "myapplication",
	"clientSecret": "secret",
	"clientAuthenticationType": "BASIC",
	"eventTypes": [
		"SchedAeroDutyLogs"
	]
}

{
  "id": "schedaero-dutylog2-12345",
  "href": "https://sandbox-schedaero.avinode.com/api/v2/dutylogs/schedaero-dutylog2-12345",
  "type": "schedaero-dutylog2",
}

Trip Task

EventType: SchedAeroTripTask

Notifies your application when a trip task is changed.

Trip Tasks can be retrieved by using the:

GET /trips/tasks/{taskid}

operation, as indicated in the webhook payload.

POST /webhooks/settings

{
	"targetURI": "https://myapplication.com/notifications",
	"displayName": "Schedaero Trip Task changes",
	"active": true,
	"clientIdentifier": "myapplication",
	"clientSecret": "secret",
	"clientAuthenticationType": "BASIC",
	"eventTypes": [
		"SchedAeroTripTask"
	]
}

{
  "id": "schedaero-triptask-12345",
  "href": "https://sandbod-schedaero.avinode.com/api/trips/tasks/schedaero-triptask-12345",
  "type": "schedaero-triptask",
}

Weight And Balance

EventType: SchedAeroWeightBalance

Notifies when a Weight-And-Balance is created or changed.

Weight and Balance details can be retrieved by using the:

GET /flightlegs/{flightlegId}/weightbalance

operation, as indicated in the webhook payload.

POST /webhooks/settings

{
	"targetURI": "https://myapplication.com/notifications",
	"displayName": "Schedaero Weight And Balance changes",
	"active": true,
	"clientIdentifier": "myapplication",
	"clientSecret": "secret",
	"clientAuthenticationType": "BASIC",
	"eventTypes": [
		"SchedAeroWeightBalance"
	]
}

{
  "id": "schedaero-flightleg-12345",
  "href": "https://sandbox-schedaero.avinode.com/api/flightlegs/schedaero-flightleg-12345/weightbalance",
  "type": "schedaero-weightbalance",
}

Trip Expenses

EventType: SchedAeroTripExpenses

Notifies when an expense is created or changed.

Trip Expense details can be retrieved by using the:

GET /expenses/{expenseid}

operation, as indicated in the webhook payload.

You can also get expenses if you have the TripID using:

GET /expenses/{tripid}/expenses

{
	"targetURI": "https://myapplication.com/notifications",
	"displayName": "Schedaero Trip Expense changes",
	"active": true,
	"clientIdentifier": "myapplication",
	"clientSecret": "secret",
	"clientAuthenticationType": "BASIC",
	"eventTypes": [
		"SchedAeroTripExpenses"
	]
}

{
  "id": "schedaero-trip-expense-12345",
  "href": "https://schedaero.avinode.com/api/expenses/schedaero-trip-expense-12345",
  "type": "schedaero-trip-expense",
  "platformTripId": null
}

Updated 2 months ago