Unfortunately, this feature is not supported on mobile devices. For the best experience, please use a computer.

project44 REST API (4.0.0)

Version 4.0.0 of project44's API

Download OpenAPI description
api.json
api.yaml
Overview
License © 2024 project44 - Terms of Use
Languages
Servers
Mock server
https://developers.project44.com/_mock/guides/shippers/visibility/ftl/api/
NA - Endpoint for project44 tenants created in the NA region
https://na12.api.project44.com/
EU - Endpoint for project44 tenants created in the EU region
https://eu12.api.project44.com/
Sandbox - Endpoint for project44 tenants created in the sandbox environment
https://na12.api.sandbox.p-44.com/

Manage Client Applications

Operations

Generate Tokens

Operations

Unified Shipment Tracking

Operations

FTL Modal Tracking

Operations

Shipment Attributes

Operations

TL: Connected Capacity

Operations

Stop Location Management

Operations

Webhook

Operations

Deprecated FTL Webhooks

Operations

Get the webhook URLs where shipment tracking updates are posted.

Request

curl -i -X GET \
  https://developers.project44.com/_mock/guides/shippers/visibility/ftl/api/api/v4/tl/webhooks/endpoints \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

OK

Body
Array [
authParamsobject

(Deprecated) The webhookAuthenticationMethod parameters. The subordinate fields for the 'authParams' field depend on the authType. This field is functional but is deprecated - authentication for new webhooks should be supplied in the 'authenticationMethods' field.

authTypestring

(Deprecated) The webhookAuthenticationMethod type. BASIC, API_KEY and OAUTH2 are supported. This field is functional but is deprecated - authentication for new webhooks should be supplied in the 'authenticationMethods' field.

Enum"API_KEY""BASIC""OAUTH2""MTLS""AD_OAUTH2_CERT"
authenticationMethodsArray of objects(WebhookAuthenticationMethod)

A list of authentication methods. Each authentication method consists of 'type' and 'parameters' fields. Typically only one form of authentication is used, though it is possible to have two API keys or both an API key and OAuth2 authentication.

configNamestring

A unique name used to identify the push configuration.

idinteger(int64)

A unique identifier of the push configuration. Assigned by the push configuration API service and used for updates only.

methodstring

The HTTP method associated with the webhook endpoint. If not provided, will default to POST.

Enum"GET""POST""PUT""PATCH"
methodHeadersobject

A map of optional headers to pass to the webhook.

methodParamsobject

A map of optional method parameters. If provided, these will appear as query parameters on the URL.

payloadFormatstring

The format of the payload to send to the webhook. JSON is the only format supported.

Value"JSON"
urlstring

The URL of the webhook endpoint.

versioninteger(int64)

An optional version of the push configuration.

]
Response
[
  {
    "authParams": {},
    "authType": "API_KEY",
    "authenticationMethods": [ … ],
    "configName": "string",
    "id": 0,
    "method": "GET",
    "methodHeaders": { … },
    "methodParams": {},
    "payloadFormat": "JSON",
    "url": "string",
    "version": 0
  }
]

Add or update webhook where shipment tracking updates are posted.

Request

Required Fields

  • id (for updates only)
  • version (for updates only)
  • configName
  • url
Body
required

pushEndpoint

authParamsobject

(Deprecated) The webhookAuthenticationMethod parameters. The subordinate fields for the 'authParams' field depend on the authType. This field is functional but is deprecated - authentication for new webhooks should be supplied in the 'authenticationMethods' field.

authTypestring

(Deprecated) The webhookAuthenticationMethod type. BASIC, API_KEY and OAUTH2 are supported. This field is functional but is deprecated - authentication for new webhooks should be supplied in the 'authenticationMethods' field.

Enum"API_KEY""BASIC""OAUTH2""MTLS""AD_OAUTH2_CERT"
authenticationMethodsArray of objects(WebhookAuthenticationMethod)

A list of authentication methods. Each authentication method consists of 'type' and 'parameters' fields. Typically only one form of authentication is used, though it is possible to have two API keys or both an API key and OAuth2 authentication.

configNamestring

A unique name used to identify the push configuration.

idinteger(int64)

A unique identifier of the push configuration. Assigned by the push configuration API service and used for updates only.

methodstring

The HTTP method associated with the webhook endpoint. If not provided, will default to POST.

Enum"GET""POST""PUT""PATCH"
methodHeadersobject

A map of optional headers to pass to the webhook.

methodParamsobject

A map of optional method parameters. If provided, these will appear as query parameters on the URL.

payloadFormatstring

The format of the payload to send to the webhook. JSON is the only format supported.

Value"JSON"
urlstring

The URL of the webhook endpoint.

versioninteger(int64)

An optional version of the push configuration.

curl -i -X PUT \
  https://developers.project44.com/_mock/guides/shippers/visibility/ftl/api/api/v4/tl/webhooks/endpoints \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "authParams": {},
    "authType": "API_KEY",
    "authenticationMethods": [
      {
        "parameters": {},
        "type": "API_KEY"
      }
    ],
    "configName": "string",
    "id": 0,
    "method": "GET",
    "methodHeaders": {
      "property1": "string",
      "property2": "string"
    },
    "methodParams": {},
    "payloadFormat": "JSON",
    "url": "string",
    "version": 0
  }'

Responses

OK

Body
authParamsobject

(Deprecated) The webhookAuthenticationMethod parameters. The subordinate fields for the 'authParams' field depend on the authType. This field is functional but is deprecated - authentication for new webhooks should be supplied in the 'authenticationMethods' field.

authTypestring

(Deprecated) The webhookAuthenticationMethod type. BASIC, API_KEY and OAUTH2 are supported. This field is functional but is deprecated - authentication for new webhooks should be supplied in the 'authenticationMethods' field.

Enum"API_KEY""BASIC""OAUTH2""MTLS""AD_OAUTH2_CERT"
authenticationMethodsArray of objects(WebhookAuthenticationMethod)

A list of authentication methods. Each authentication method consists of 'type' and 'parameters' fields. Typically only one form of authentication is used, though it is possible to have two API keys or both an API key and OAuth2 authentication.

configNamestring

A unique name used to identify the push configuration.

idinteger(int64)

A unique identifier of the push configuration. Assigned by the push configuration API service and used for updates only.

methodstring

The HTTP method associated with the webhook endpoint. If not provided, will default to POST.

Enum"GET""POST""PUT""PATCH"
methodHeadersobject

A map of optional headers to pass to the webhook.

methodParamsobject

A map of optional method parameters. If provided, these will appear as query parameters on the URL.

payloadFormatstring

The format of the payload to send to the webhook. JSON is the only format supported.

Value"JSON"
urlstring

The URL of the webhook endpoint.

versioninteger(int64)

An optional version of the push configuration.

Response
{
  "authParams": {},
  "authType": "API_KEY",
  "authenticationMethods": [
    { … }
  ],
  "configName": "string",
  "id": 0,
  "method": "GET",
  "methodHeaders": {
    "property1": "string",
    "property2": "string"
  },
  "methodParams": {},
  "payloadFormat": "JSON",
  "url": "string",
  "version": 0
}

Delete a given webhook endpoint - if one is defined.

Request

Required Fields

  • id
Path
idinteger(int64)required

The project44-generated id of the endpoint being deleted.

curl -i -X DELETE \
  'https://developers.project44.com/_mock/guides/shippers/visibility/ftl/api/api/v4/tl/webhooks/endpoints/{id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

OK

Body
Response
{
  "httpStatusCode": 0,
  "httpMessage": "string",
  "errorMessage": "string",
  "errors": [
    { … }
  ],
  "supportReferenceId": "string"
}