Webhook

Webhook 1.0.0

5
Average: 5 (1 vote)
forum Discuss this API in the forum
development
https://api-sandbox.supplychain.fedex.com/api/sandbox

Paths

/services/webhook

get /services/webhook

Retrieves webhook subscription(s) for the merchant.

Retrieves webhook subscription(s) for the merchant.

To use this operation you must use one of the following sets of security requirements.
oauth2
oauth2
(oauth2 accessCode)
Authorization URL
https://api-sandbox.supplychain.fedex.com/api/sandbox/fsc/oauth2/authorize
Token URL
https://api-sandbox.supplychain.fedex.com/api/sandbox/fsc/oauth2/token
Scopes
Fulfillment_Returns
Fulfillment_Returns
Client_Secret
X-IBM-Client-Secret
(apiKey located in header)
Client_Id
X-IBM-Client-Id
(apiKey located in header)
AccessToken
Optional in header
string

Enter AccessToken, it is mandatory in case of basic authentication.

query_params
Optional in query
string

Enter all the query parameters. Sample: status=Active&eventName=Order_Shipped

Accept
Optional in header
string
application/json
fsc-api-admin@fedex.com
200

200 OK

Example Request
Example Response
GET https://api-sandbox.supplychain.fedex.com/api/sandbox/v1/services/webhook
Try this operation
https://api-sandbox.supplychain.fedex.com/api/sandbox/v1/services/webhook
accept
AccessToken
query_params
post /services/webhook

This API allows the developer to create a new webhook subscription.

This API allows the developer to create a new webhook subscription.

To use this operation you must use one of the following sets of security requirements.
oauth2
oauth2
(oauth2 accessCode)
Authorization URL
https://api-sandbox.supplychain.fedex.com/api/sandbox/fsc/oauth2/authorize
Token URL
https://api-sandbox.supplychain.fedex.com/api/sandbox/fsc/oauth2/token
Scopes
Fulfillment_Returns
Fulfillment_Returns
Client_Secret
X-IBM-Client-Secret
(apiKey located in header)
Client_Id
X-IBM-Client-Id
(apiKey located in header)
AccessToken
Optional in header
string

Enter AccessToken, it is mandatory in case of basic authentication.

create_webhook_json_body
Optional in body
object

{"eventName": "Order_Shippped","url": "https://yourcompany.com/webhook/callbackURL","secret":"top_secret"}

{
    "schema": {
        "type": "object"
    }
}
Content-Type
Optional in header
string
application/json
Accept
Optional in header
string
application/json
fsc-api-admin@fedex.com
200

200 OK

Example Request
Example Response
POST https://api-sandbox.supplychain.fedex.com/api/sandbox/v1/services/webhook
Try this operation
https://api-sandbox.supplychain.fedex.com/api/sandbox/v1/services/webhook
content-type
accept
AccessToken

/services/webhook/{webhookId}

put /services/webhook/{webhookId}

This API allows the developer to update an existing webhook subscription.

This API allows the developer to update an existing webhook subscription.

To use this operation you must use one of the following sets of security requirements.
oauth2
oauth2
(oauth2 accessCode)
Authorization URL
https://api-sandbox.supplychain.fedex.com/api/sandbox/fsc/oauth2/authorize
Token URL
https://api-sandbox.supplychain.fedex.com/api/sandbox/fsc/oauth2/token
Scopes
Fulfillment_Returns
Fulfillment_Returns
Client_Secret
X-IBM-Client-Secret
(apiKey located in header)
Client_Id
X-IBM-Client-Id
(apiKey located in header)
create_webhook_json_body
Optional in body
object

{"eventName": "Order_Shippped","url": "https://yourcompany.com/webhook/callbackURL","secret":"top_secret"}

{
    "schema": {
        "type": "object"
    }
}
AccessToken
Optional in header
string

Enter AccessToken, it is mandatory in case of basic authentication.

webhookId
Required in path
string

webhookId

Content-Type
Optional in header
string
application/json
Accept
Optional in header
string
application/json
fsc-api-admin@fedex.com
200

200 OK

Example Request
Example Response
PUT https://api-sandbox.supplychain.fedex.com/api/sandbox/v1/services/webhook/{webhookId}
Try this operation
https://api-sandbox.supplychain.fedex.com/api/sandbox/v1/services/webhook/{webhookId}
content-type
accept
AccessToken
webhookId