Skip to main content
POST
Creates a webhook subscription

Authorizations

Authorization
string
header
required

Access token obtained from the /oauth/token endpoint using your client credentials.

Body

application/json

Request body for creating a webhook subscription.

url
string

HTTPS endpoint that webhook events are delivered to.

eventTypes
enum<string>[]

Event types to subscribe to.

Event type that a webhook subscription covers. Deliveries carry the corresponding CloudEvent type string (e.g. net.fuelboss.nomination.created) in their type field.

Possible values:

  • nomination_cancelled — Nomination has been cancelled.
  • nomination_bunkering_location_changed — Nomination bunkering location has changed.
  • nomination_fuel_specification_changed — Nomination fuel specification has changed.
  • nomination_receiver_vessel_changed — Nomination receiver vessel has changed.
  • nomination_supplier_asset_changed — Nomination supplier asset has changed.
  • operation_started — Bunkering operation has started.
  • operation_ended — Bunkering operation has ended.
  • nomination_created — Nomination has been created.
  • nomination_draft_upserted — Draft nomination has been created or updated.
  • nomination_bunkering_start_time_changed — Nomination estimated bunkering start time (the nomination BST) has changed.
  • nomination_bunkering_end_time_changed — Nomination estimated bunkering end time (estimated time of completion) has changed.
  • nomination_contract_changed — Nomination contract has changed.
  • nomination_company_entity_changed — Nomination supplier company entity has changed.
  • nomination_counterpart_entity_changed — Nomination counterpart entity has changed.
Available options:
nomination_cancelled,
nomination_bunkering_location_changed,
nomination_fuel_specification_changed,
nomination_receiver_vessel_changed,
nomination_supplier_asset_changed,
operation_started,
operation_ended,
nomination_created,
nomination_draft_upserted,
nomination_bunkering_start_time_changed,
nomination_bunkering_end_time_changed,
nomination_contract_changed,
nomination_company_entity_changed,
nomination_counterpart_entity_changed
secret
null | string

Secret used to compute the HMAC signature sent with each delivery, so you can verify the payload originates from FuelBoss.

headers
null | object

Custom HTTP headers included in every delivery to your endpoint (e.g. for authentication). Header values are stored securely and never returned.

Response

Created

A webhook subscription belonging to your company.

id
string<uuid>

System-generated unique identifier of the subscription. Use it to delete the subscription.

url
string

HTTPS endpoint that webhook events are delivered to.

eventTypes
enum<string>[]

Event types the subscription covers.

Event type that a webhook subscription covers. Deliveries carry the corresponding CloudEvent type string (e.g. net.fuelboss.nomination.created) in their type field.

Possible values:

  • nomination_cancelled — Nomination has been cancelled.
  • nomination_bunkering_location_changed — Nomination bunkering location has changed.
  • nomination_fuel_specification_changed — Nomination fuel specification has changed.
  • nomination_receiver_vessel_changed — Nomination receiver vessel has changed.
  • nomination_supplier_asset_changed — Nomination supplier asset has changed.
  • operation_started — Bunkering operation has started.
  • operation_ended — Bunkering operation has ended.
  • nomination_created — Nomination has been created.
  • nomination_draft_upserted — Draft nomination has been created or updated.
  • nomination_bunkering_start_time_changed — Nomination estimated bunkering start time (the nomination BST) has changed.
  • nomination_bunkering_end_time_changed — Nomination estimated bunkering end time (estimated time of completion) has changed.
  • nomination_contract_changed — Nomination contract has changed.
  • nomination_company_entity_changed — Nomination supplier company entity has changed.
  • nomination_counterpart_entity_changed — Nomination counterpart entity has changed.
Available options:
nomination_cancelled,
nomination_bunkering_location_changed,
nomination_fuel_specification_changed,
nomination_receiver_vessel_changed,
nomination_supplier_asset_changed,
operation_started,
operation_ended,
nomination_created,
nomination_draft_upserted,
nomination_bunkering_start_time_changed,
nomination_bunkering_end_time_changed,
nomination_contract_changed,
nomination_company_entity_changed,
nomination_counterpart_entity_changed
createdAtUtc
string<date-time>

Timestamp (UTC) when the subscription was created.

headerKeys
null | string[]

Names of the custom headers configured for the subscription. Header values are never returned.