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. URLs targeting private, loopback, or link-local network addresses are rejected, including hostnames that resolve to such addresses.

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. When omitted, FuelBoss generates a random secret. In both cases the secret is returned once, in the response to this request, and cannot be retrieved later.

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.

version
null | integer<int32>

Version of the webhook payload schema delivered to this subscription, covering all of its event types. Defaults to 1 when omitted; unsupported versions are rejected. Every delivery identifies its version in the envelope's dataschema field. See Payload versions.

Response

Created

The webhook subscription that was created, including its signing secret. This is the only response that contains the secret.

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
secret
string

Secret used to compute the HMAC-SHA256 X-Webhook-Signature of every delivery: the value you supplied, or the one FuelBoss generated when the request omitted secret. It is returned only in this response and cannot be retrieved later, so store it securely. See Signature verification.

createdAtUtc
string<date-time>

Timestamp (UTC) when the subscription was created.

version
integer<int32>

Version of the webhook payload schema delivered to this subscription. See Payload versions.

headerKeys
null | string[]

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