3941

I use Ubuntu and installed cURL on it. I want to test my Spring REST application with cURL. I wrote my POST code at the Java side. However, I want to test it with cURL. I am trying to post a JSON data. Example data is like this:

{"value":"30","type":"Tip 3","targetModule":"Target 3","configurationGroup":null,"name":"Configuration Deneme 3","description":null,"identity":"Configuration Deneme 3","version":0,"systemId":3,"active":true}

I use this command:

curl -i \
 -H "Accept: application/json" \
 -H "X-HTTP-Method-Override: PUT" \
 -X POST -d "value":"30","type":"Tip 3","targetModule":"Target 3","configurationGroup":null,"name":"Configuration Deneme 3","description":null,"identity":"Configuration Deneme 3","version":0,"systemId":3,"active":true \
 http://localhost:8080/xx/xxx/xxxx

It returns this error:

HTTP/1.1 415 Unsupported Media Type
Server: Apache-Coyote/1.1
Content-Type: text/html;charset=utf-8
Content-Length: 1051
Date: 2011年8月24日 08:50:17 GMT

The error description is this:

The server refused this request because the request entity is in a format not supported by the requested resource for the requested method ().

Tomcat log: "POST /ui/webapp/conf/clear HTTP/1.1" 415 1051

What is the right format of the cURL command?

This is my Java side PUT code (I have tested GET and DELETE and they work):

@RequestMapping(method = RequestMethod.PUT)
public Configuration updateConfiguration(HttpServletResponse response, @RequestBody Configuration configuration) { //consider @Valid tag
 configuration.setName("PUT worked");
 //todo If error occurs response.sendError(HttpServletResponse.SC_NOT_FOUND);
 return configuration;
}
Benjamin Loison
5,7704 gold badges20 silver badges37 bronze badges
asked Aug 24, 2011 at 8:51
4
  • 7
    checkout the link for spring 3.2.0 post requests. Commented Jun 5, 2013 at 9:41
  • 14
    There is a nice post Using Curl For Ad Hoc Testing Of RESTful Microservices which covers this with multiple examples. Commented Aug 28, 2016 at 11:03
  • By the way, it's better to minify json data before sending to server. Use smart json to is a better choice in 2023. Commented Jan 10, 2023 at 13:12
  • This post is being discussed on Meta. Commented Nov 10, 2025 at 18:48

31 Answers 31

1
2
5858

You need to set your content-type to application/json. But -d (or --data) sends the Content-Type application/x-www-form-urlencoded by default, which is not accepted on Spring's side.

Looking at the curl man page, I think you can use -H (or --header):

-H "Content-Type: application/json"

Full example:

curl --header "Content-Type: application/json" \
 --request POST \
 --data '{"username":"xyz","password":"xyz"}' \
 http://localhost:3000/api/login

(-H is short for --header, -d for --data)

Note that -request POST is optional if you use -d, as the -d flag implies a POST request.


On Windows, things are slightly different. See the comment thread.

Benjamin Loison
5,7704 gold badges20 silver badges37 bronze badges
answered Aug 24, 2011 at 9:12
Sign up to request clarification or add additional context in comments.

30 Comments

For windows, single quotes around json did not work and I ended up escaping double quotes. curl -X POST -H "Content-Type: application/json" -d "{ \"key1\": \"value1\" }" http://localhost:3000/api/method
For me under Windows I needed to escape quotes using quotes in this format "{ """key1""": """value1""" }". Also this answer: stackoverflow.com/questions/18314796/…
I've had issues with POST requests but solved it by capitalized "Application/json" so if you get a 415 error, check the capitalization.
@Adam Tuttle Why does your comment have so many upvotes? With curl on ubuntu 14.04, you need "Content-Type: application/json", not just "application/json". This wasted a lot of my time...
@ostrokach sorry it wasted your time. syntax worked fine for me on OSX when I posted it (haven't retried). Guess it is/was just a platform difference. I imagine the upvotes are from people that it helped.
|
768

Try to put your data in a file, say body.json and then use

curl -H "Content-Type: application/json" --data @body.json http://localhost:8080/ui/webapp/conf
Benjamin Loison
5,7704 gold badges20 silver badges37 bronze badges
answered Aug 24, 2011 at 10:04

13 Comments

You probably should use the --data-binary option instead of --data. One would expect that the client sends the data as-is, but --data strips CR und LF from the input.
Using cUrl with inline json Strings seems to be a nightmare. There's the need to scape the double quote character. Going with a file like this is nicer.
It's important to add an @ character before the name of the file, otherwise it won't work. I just spent 20 minutes banging my head at this crap...
This way you can also run a JSON lint on the file to see if there's an error in parsing the JSON.
On Windows, you need double quotes around the filename "@body.json"
|
167

For Windows, having a single quote for the -d value did not work for me, but it did work after changing to double quote. Also I needed to escape double quotes inside curly brackets.

That is, the following did not work:

curl -i -X POST -H "Content-Type: application/json" -d '{"key":"val"}' http://localhost:8080/appname/path

But the following worked:

curl -i -X POST -H "Content-Type: application/json" -d "{\"key\":\"val\"}" http://localhost:8080/appname/path
Peter Mortensen
31.3k22 gold badges110 silver badges134 bronze badges
answered Jun 30, 2014 at 22:12

5 Comments

FYI - looks like you're missing a closing double quote around the json body
For me on Windows, the " around the data does not work, no quotes works instead
If you're using PowerShell, see this answer.
For improved quote-handling, and many other reasons, stop using the ancient/weak cmd.exe and try one of the improved shells like Git-Bash from gitforwindows.org site. (Highly recommended, even if you don't use Git.)
yep, quoting behaviour is a mess in pwsh. But it should be fixed in pwsh 7.3, in 7.2 you can run Enable-ExperimentalFeature PSNativeCommandArgumentPassing to not have to escape this quotes
121

You might find Resty useful:

It's a wrapper round CURL which simplifies command line REST requests. You point it to your API endpoint, and it gives you PUT and POST commands (Examples adapted from the homepage).

resty http://127.0.0.1:8080/data # Sets up Resty to point at your endpoint
GET /blogs.json # Gets http://127.0.0.1:8080/data/blogs.json
 # Put JSON
PUT /blogs/2.json '{"id" : 2, "title" : "updated post", "body" : "This is the new."}'
 # POST JSON from a file
POST /blogs/5.json < /tmp/blog.json

Also, it's often still necessary to add the Content Type headers. You can do this once, though, to set a default, of adding configuration files per-method per-site: Setting default Resty options

Peter Mortensen
31.3k22 gold badges110 silver badges134 bronze badges
answered Jan 12, 2012 at 19:10

Comments

111

It worked for me using:

curl -H "Accept: application/json" -H "Content-type: application/json" -X POST -d '{"id":100}' http://localhost/api/postJsonReader.do

It was happily mapped to the Spring controller:

@RequestMapping(value = "/postJsonReader", method = RequestMethod.POST)
public @ResponseBody String processPostJsonData(@RequestBody IdOnly idOnly) throws Exception {
 logger.debug("JsonReaderController hit! Reading JSON data!"+idOnly.getId());
 return "JSON Received";
}

IdOnly is a simple POJO with an id property.

Peter Mortensen
31.3k22 gold badges110 silver badges134 bronze badges
answered Apr 19, 2012 at 16:00

Comments

85

You can use Postman to convert to CURL:

Enter image description here

Enter image description here

Note:

The latest Postman version has some UI upgrades and now the code link is available in the sidebar.

Enter image description here

Peter Mortensen
31.3k22 gold badges110 silver badges134 bronze badges
answered May 30, 2019 at 6:43

1 Comment

This is a nice way for beginners to understand mapping from a UI tool like this to the curl command, but it's not sustainable in the long term as another dependency to learn and maintain
66

As an example, create a JSON file, params.json, and add this content to it:

[
 {
 "environment": "Devel",
 "description": "Machine for test, please do not delete!"
 }
]

Then you run this command:

curl -v -H "Content-Type: application/json" -X POST --data @params.json -u your_username:your_password http://localhost:8000/env/add_server
Peter Mortensen
31.3k22 gold badges110 silver badges134 bronze badges
answered Jan 5, 2016 at 23:10

1 Comment

Pro tip: add this line to your ~/.curlrc file: --header Content-Type:Application/JSON
54

TL;DR:

Use the holy trinity, jo + curl + jq (or fx):

jo value=30 type="Tip 3" targetModule="Target 3" configurationGroup=null name="Configuration Deneme 3" description=null identity="Configuration Deneme 3" | \
curl --json @- \
 -X POST \
 http://localhost:8080/xx/xxx/xxxx | \
jq

This will cover necessary headers that were missing: no need to explicitly define the Content-Type and Accept headers.

The new curl way with --json

Early March 2022, curl released a new command line parameter --json with version 7.82.0. This allows for a shortcut to send through JSON and eliminating the need to define the Content-Type that you had missing and Accept headers as these are automatically assumed, hence reducing risk of mistakes:

curl --json '{"tool": "curl"}' https://example.com/

But wait... there is more. Instead of defining the json parameter as a string to the curl command line, use the nifty jo CLI tool to define JSON as series of key value pairs and pipe the output through curl. Using jo only to define your JSON, it works this way:

 > jo -p value=30 type="Tip 3" targetModule="Target 3" configurationGroup=null name="Configuration Deneme 3" description=null identity="Configuration Deneme 3"
version=0 systemId=3 active=true
{
 "value": 30,
 "type": "Tip 3",
 "targetModule": "Target 3",
 "configurationGroup": null,
 "name": "Configuration Deneme 3",
 "description": null,
 "identity": "Configuration Deneme 3",
 "version": 0,
 "systemId": 3,
 "active": true
}

Let's showcase this now with a similar curl command of yours but without extra headers and using jo + jq for nice output:

jo value=30 type="Tip 3" targetModule="Target 3" configurationGroup=null name="Configuration Deneme 3" description=null identity="Configuration Deneme 3" | \
curl --json @- \
 -X POST \
 http://localhost:8080/xx/xxx/xxxx | \
jq

Example with a free API

Using a free mock API for demonstration:

> jo title="Blog Post" body="lorem ipsum" userId=33 | \
curl --json @- \
 -X POST \
 https://jsonplaceholder.typicode.com/posts | \
jq

The output has a pretty format thanks to jq:

{
 "title": "Blog Post",
 "body": "lorem ipsum",
 "userId": 33,
 "id": 101
}
miken32
42.5k16 gold badges127 silver badges177 bronze badges
answered Feb 8, 2022 at 1:19

3 Comments

If you installed curl via brew, you can also brew upgrade curl to get 7.82.0
Seems jo doesn't like a value of @ (example: DNS records) replace with \@ in that case.
This answer introduces a bunch of unneeded noise. OP already had JSON, generating it does not need to be part of a solution. Ditto for outputting anything, formatted or not – OP did not ask for this. Still upvoted because --json is indeed the way this should be done now.
51

I just run into the same problem. I could solve it by specifying

-H "Content-Type: application/json; charset=UTF-8"
answered Nov 15, 2011 at 15:45

Comments

46

This worked well for me.

curl -X POST --data @json_out.txt http://localhost:8080/

Where,

-X Means the HTTP verb.

--data Means the data you want to send.

Peter Mortensen
31.3k22 gold badges110 silver badges134 bronze badges
answered Jul 1, 2015 at 14:31

3 Comments

The -X POST is redundant in this example
@SoftwareEngineer but at least it's instructive for begginers.
Better have transparent but redundant code, rather than non-transparent code. I also prefer --data instead of -d. It depends on how good the team is with Bash overall, but definitely easier for Bash beginners, and people who don't use it on a daily basis.
42

You can use Postman with its intuitive GUI to assemble your cURL command.

  1. Install and Start Postman
  2. Type in your URL, Post Body, Request Headers etc. pp.
  3. Click on Code
  4. Select cURL from the drop-down list
  5. copy & paste your cURL command

Note: There are several options for automated request generation in the drop-down list, which is why I thought my post was neccessary in the first place.

answered Sep 25, 2017 at 12:47

1 Comment

Didn't realize that feature was included in Postman. Thanks for pointing it out!
37

HTTPie is a recommended alternative to curl because you can do just

http POST http://example.com/some/endpoint name=value name1=value1

It speaks JSON by default and will handle both setting the necessary header for you as well encoding data as valid JSON. There is also:

Some-Header:value

for headers, and

name==value

for query string parameters. If you have a large chunk of data, you can also read it from a file have it be JSON encoded:

[email protected]
Peter Mortensen
31.3k22 gold badges110 silver badges134 bronze badges
answered Nov 8, 2017 at 12:45

5 Comments

I pray for this to be a standard - at least in terms of being available / preinstalled on each server.
Also, it would be great if httpie supported spilling out the curl formatted command, for the situation when httpie is not available on a specific host.
@smido I pray too. After one will adapt this tool, there is literally no way to go back as it is more understandable by humans, not machines.
@smido It could be unavailable on system, but it could be easily installed as "pip user install" (pip install --user ...), then only one remaining thing to do is export PATH="~/.local/bin:$PATH". Python is available out of the box on most systems.
@smido Check this issue, I think you could find solution to a problem you mentioned here: github.com/httpie/cli/issues/325
33

Using CURL Windows, try this:

curl -X POST -H "Content-Type:application/json" -d "{\"firstName\": \"blablabla\",\"lastName\": \"dummy\",\"id\": \"123456\"}" http-host/_ah/api/employeeendpoint/v1/employee
Peter Mortensen
31.3k22 gold badges110 silver badges134 bronze badges
answered Dec 20, 2014 at 23:45

Comments

27

Use the -d option to add payload

curl -X POST \
 http://<host>:<port>/<path> \
 -H 'Accept: application/json' \
 -H 'Content-Type: application/json' \
 -d '{
 "foo": "bar",
 "lorem": "ipsum"
 }'

In addition:

Use -X POST to use the POST method.

Use -H 'Accept: application/json' to add an accept type header.

Use -H 'Content-Type: application/json' to add a content type header.

Peter Mortensen
31.3k22 gold badges110 silver badges134 bronze badges
answered Apr 13, 2019 at 20:06

2 Comments

I tried to use it but getting {"errors":["no data provided"]} error.
@Suresh try curl's -v switch to get more details. The service you are hitting may be only handling certain content-type values.
25

If you're testing a lot of JSON send/responses against a RESTful interface, you may want to check out the Postman plug-in for Chrome (which allows you to manually define web service tests) and its Node.js-based Newman command-line companion (which allows you to automate tests against "collections" of Postman tests.) Both free and open!

törzsmókus
2,0613 gold badges25 silver badges31 bronze badges
answered May 23, 2014 at 13:34

Comments

25

This worked well for me, additionally using BASIC authentication:

curl -v --proxy '' --basic -u Administrator:password -X POST -H "Content-Type: application/json"
 --data-binary '{"value":"30","type":"Tip 3","targetModule":"Target 3","configurationGroup":null,"name":"Configuration Deneme 3","description":null,"identity":"Configuration Deneme 3","version":0,"systemId":3,"active":true}'
 http://httpbin.org/post

Of course, you should never use BASIC authentication without SSL and a checked certificate.

I ran into this again today, using Cygwin's cURL 7.49.1 for Windows... And when using --data or --data-binary with a JSON argument, cURL got confused and would interpret the {} in the JSON as a URL template. Adding a -g argument to turn off cURL globbing fixed that.

See also Passing a URL with brackets to curl .

Peter Mortensen
31.3k22 gold badges110 silver badges134 bronze badges
answered Jun 5, 2013 at 23:24

Comments

22

You could also put your JSON content in a file and pass it to curl using the --upload-file option via standard input, like this:

echo 'my.awesome.json.function({"do" : "whatever"})' | curl -X POST "http://url" -T -
Peter Mortensen
31.3k22 gold badges110 silver badges134 bronze badges
answered Jun 13, 2017 at 19:41

Comments

20

I had the issue of:

curl -X POST http://your-server-end-point -H "Content-Type: application/json" -d @path-of-your-json-file.json

See, I did everything right. Only one thing - I missed "@" before the JSON file path.

I found one relevant go-to document on Internet - Common Options .

Peter Mortensen
31.3k22 gold badges110 silver badges134 bronze badges
answered Apr 28, 2020 at 13:54

Comments

19

This worked for me:

curl -H "Content-Type: application/json" -X POST -d @./my_json_body.txt http://192.168.1.1/json
Misa Lazovic
2,83110 gold badges34 silver badges39 bronze badges
answered Oct 16, 2016 at 16:07

Comments

19

Here is another way to do it, if you have dynamic data to be included.

#!/bin/bash
version=1ドル
text=2ドル
branch=$(git rev-parse --abbrev-ref HEAD)
repo_full_name=$(git config --get remote.origin.url | sed 's/.*:\/\/github.com\///;s/.git$//')
token=$(git config --global github.token)
generate_post_data()
{
 cat <<EOF
{
 "tag_name": "$version",
 "target_commitish": "$branch",
 "name": "$version",
 "body": "$text",
 "draft": false,
 "prerelease": false
}
EOF
}
echo "Create release $version for repo: $repo_full_name branch: $branch"
curl --data "$(generate_post_data)" "https://api.github.com/repos/$repo_full_name/releases?access_token=$token"
answered Aug 6, 2019 at 6:02

Comments

13

This worked for me for on Windows 10:

curl -d "{"""owner""":"""sasdasdasdasd"""}" -H "Content-Type: application/json" -X PUT http://localhost:8080/api/changeowner/CAR4
Peter Mortensen
31.3k22 gold badges110 silver badges134 bronze badges
answered Jul 9, 2019 at 9:58

Comments

13

I am using the below format to test with a web server.

use -F 'json data'

Let's assume this JSON dict format:

{
 'comment': {
 'who': 'some_one',
 'desc': 'get it'
 }
}

Full example

curl -XPOST your_address/api -F comment='{"who":"some_one", "desc":"get it"}'
Peter Mortensen
31.3k22 gold badges110 silver badges134 bronze badges
answered Jan 10, 2014 at 6:49

1 Comment

I can't see how this could possibly be a general-purpose answer. Your server may be configured to handle this strange format, but YMMV.
10

--json <data> Sends the specified JSON data in a POST request to the HTTP server.

curl 7.82.0+

# Send a basic JSON object
curl --json '{"name":"xyz","breed":"xyz","age":100}' http://127.0.0.1:3000/cats
# letter @, read the data from a file
curl --json @cat.txt http://127.0.0.1:3000/cats
# letter -, read the data from stdin
echo '{"name":"xyz","breed":"xyz","age":100}' | curl --json @- http://127.0.0.1:3000/cats

curl 7.82.0-

curl -X POST --header "Content-Type: application/json" --data '{"name":"xyz","breed":"xyz","age":100}' http://127.0.0.1:3000/cats
answered Nov 12, 2022 at 8:26

Comments

9

For PowerShell I've used:

curl.exe -H "Content-Type: application/json" --data "@content.json" http://localhost:8080/appname/path

Where content.json was the name of the JSON file on my local containing the request, and curl.exe instead of just curl not to use the alias for Invoke-WebRequest .

Or if you want to specify directly the JSON:

curl.exe -H "Content-Type: application/json" --data '{\"username\":\"xyz\",\"password\":\"xyz\"}' http://localhost:8080/appname/path
Peter Mortensen
31.3k22 gold badges110 silver badges134 bronze badges
answered Aug 6, 2021 at 7:47

Comments

9

I made a tool called fetcher for this. It can send requests and format curl snippets:

Here's an example:

Enter image description here

Example output:

curl -XGET -H "Accept: application/json" -d "{\"value\":\"30\",\"type\":\"Tip 3\",\"targetModule\":\"Target 3\",\"configurationGroup\":null,\"name\":\"Configuration Deneme 3\",\"description\":null,\"identity\":\"Configuration Deneme 3\",\"version\":0,\"systemId\":3,\"active\":true}" "http://localhost:8080/xx/xxx/xxxx"
Peter Mortensen
31.3k22 gold badges110 silver badges134 bronze badges
answered May 27, 2019 at 11:40

1 Comment

Request/tip: URL links should be clearly spelled out. (Not just mysterious "click here.") Especially for self-promotion of your homemade tool.
4
  • -H to send something like content-type or an authentication token in the header
  • -d here adds your data
  • finally add a site link

Note: Don't forget to add an authentication token (if you have) for authentication credentials

curl -X POST -H 'Content-Type: application/json' -H 'Authorization: Token 2de403987713595a7955a9b4655b9e206d4294b3' -d '{"title":"Post test with curl", "body": "test body"}' http://127.0.0.1:8000/api/v1/feeds/
Peter Mortensen
31.3k22 gold badges110 silver badges134 bronze badges
answered Oct 31, 2021 at 5:37

Comments

4

It is as simple as this:

curl -X POST https://localhost:3000/ 
 -H "Content-Type: application/json"
 -d '{"productId": 123456, "quantity": 100}'
Peter Mortensen
31.3k22 gold badges110 silver badges134 bronze badges
answered Oct 17, 2022 at 6:50

Comments

2

You can cat the contents of a JSON file to curl via the --data-raw parameter.

curl 'https://api.com/route' -H 'Content-Type: application/json' --data-raw "$(cat ~/.json/payload-2022年03月03日.json | grep -v '^\s*//')"

Note: comments in the JSON file are filtered out via grep -v '^\s*//'

You can also pass the data to curl via standard input using grep or cat.

grep -v '^\s*//' ~/.json/payload-2022年03月03日.json | curl 'https://api.com/route' -H 'Content-Type: application/json' -d @-

cat ~/.json/payload-2022年03月03日.json | grep -v '^\s*//' | curl 'https://api.com/route' -H 'Content-Type: application/json' -d @-

Peter Mortensen
31.3k22 gold badges110 silver badges134 bronze badges
answered Mar 3, 2022 at 16:51

Comments

2

The issue is here:

HTTP/1.1 415 Unsupported Media Type

Server Login can't interpret the Media Type of this request, so it is parsing it as text/html

The media type of any resource is declared in the Content-Type property of the request header

"accept" ... header will fail this request, so the following is required for any JSON request to be sent i.e. content-type

-H 'content-type: application/json'

Suppose data and URL are something like this

{"email": "[email protected]","password": "123456"}

http://localhost:5000/api/login

Then in Linux

curl http://localhost:5000/api/login -H 'content-type: application/json' -d '{"email": "[email protected]", "password": "123456"}'

In Windows (single quotes around parameters will not work)

curl http://localhost:5000/api/login -H "content-type: application/json" -d "{\"email\": \"[email protected]\", \"password\": \"123456\"}"

-X POST key is not required when -d {.....} is present in command.

For a PUT request:

-X PUT
Peter Mortensen
31.3k22 gold badges110 silver badges134 bronze badges
answered Nov 28, 2021 at 9:31

Comments

2

Based on Anand Rockzz's answer, here is what I did to this on GitHub Actions. It was a bit tricky due to the EOF tag.

My goal was to send an HTTP call once a Vercel deployment was finished (similar to a webhook).

This real-world example might help other people.

send-webhook-callback-once-deployment-ready:
 name: Invoke webhook callback url defined by the customer (Ubuntu 18.04)
 runs-on: ubuntu-18.04
 needs: await-for-vercel-deployment
 steps:
 - uses: actions/checkout@v1 # Get last commit pushed - See https://github.com/actions/checkout
 - name: Expose GitHub slug/short variables # See https://github.com/rlespinasse/github-slug-action#exposed-github-environment-variables
 uses: rlespinasse/[email protected] # See https://github.com/rlespinasse/github-slug-action
 - name: Expose git environment variables and call webhook (if provided)
 # Workflow overview:
 # - Resolves webhook url from customer config file
 # - If a webhook url was defined, send a
 run: |
 MANUAL_TRIGGER_CUSTOMER="${{ github.event.inputs.customer}}"
 CUSTOMER_REF_TO_DEPLOY="${MANUAL_TRIGGER_CUSTOMER:-$(cat vercel.json | jq --raw-output '.build.env.NEXT_PUBLIC_CUSTOMER_REF')}"
 VERCEL_DEPLOYMENT_COMPLETED_WEBHOOK=$(cat vercel.$CUSTOMER_REF_TO_DEPLOY.staging.json | jq --raw-output '.build.env.VERCEL_DEPLOYMENT_COMPLETED_WEBHOOK')
 # Checking if a webhook url is defined
 if [ -n "$VERCEL_DEPLOYMENT_COMPLETED_WEBHOOK" ]; then
 # Run script that populates git-related variables as ENV variables
 echo "Running script populate-git-env.sh"
 . ./scripts/populate-git-env.sh
 echo "Resolved git variables:"
 echo "'GIT_COMMIT_SHA': $GIT_COMMIT_SHA"
 echo "'GIT_COMMIT_REF': $GIT_COMMIT_REF"
 echo "'GIT_COMMIT_TAGS': $GIT_COMMIT_TAGS"
 # Generates JSON using a bash function - See https://stackoverflow.com/a/57369772/2391795
 # "End Of File" must be at the beginning of the line with no space/tab before or after - See https://stackoverflow.com/a/12909284/2391795
 # But, when executed by GitHub Action, it must be inside the "run" section instead
 generate_post_data() {
 cat <<EOF
 {
 "MANUAL_TRIGGER_CUSTOMER": "${MANUAL_TRIGGER_CUSTOMER}",
 "CUSTOMER_REF": "${CUSTOMER_REF_TO_DEPLOY}",
 "STAGE": "staging",
 "GIT_COMMIT_SHA": "${GIT_COMMIT_SHA}",
 "GIT_COMMIT_REF": "${GIT_COMMIT_REF}",
 "GIT_COMMIT_TAGS": "${GIT_COMMIT_TAGS}",
 "GITHUB_REF_SLUG": "${GITHUB_REF_SLUG}",
 "GITHUB_HEAD_REF_SLUG": "${GITHUB_HEAD_REF_SLUG}",
 "GITHUB_BASE_REF_SLUG": "${GITHUB_BASE_REF_SLUG}",
 "GITHUB_EVENT_REF_SLUG": "${GITHUB_EVENT_REF_SLUG}",
 "GITHUB_REPOSITORY_SLUG": "${GITHUB_REPOSITORY_SLUG}",
 "GITHUB_REF_SLUG_URL": "${GITHUB_REF_SLUG_URL}",
 "GITHUB_HEAD_REF_SLUG_URL": "${GITHUB_HEAD_REF_SLUG_URL}",
 "GITHUB_BASE_REF_SLUG_URL": "${GITHUB_BASE_REF_SLUG_URL}",
 "GITHUB_EVENT_REF_SLUG_URL": "${GITHUB_EVENT_REF_SLUG_URL}",
 "GITHUB_REPOSITORY_SLUG_URL": "${GITHUB_REPOSITORY_SLUG_URL}",
 "GITHUB_SHA_SHORT": "${GITHUB_SHA_SHORT}"
 }
 EOF
 }
 echo "Print generate_post_data():"
 echo "$(generate_post_data)"
 echo "Calling webhook at '$VERCEL_DEPLOYMENT_COMPLETED_WEBHOOK'"
 echo "Sending HTTP request (curl):"
 curl POST \
 "$VERCEL_DEPLOYMENT_COMPLETED_WEBHOOK" \
 -vs \
 --header "Accept: application/json" \
 --header "Content-type: application/json" \
 --data "$(generate_post_data)" \
 2>&1 | sed '/^* /d; /bytes data]$/d; s/> //; s/< //'
 # XXX See https://stackoverflow.com/a/54225157/2391795
 # -vs - add headers (-v) but remove progress bar (-s)
 # 2>&1 - combine stdout and stderr into single stdout
 # sed - edit response produced by curl using the commands below
 # /^* /d - remove lines starting with '* ' (technical info)
 # /bytes data]$/d - remove lines ending with 'bytes data]' (technical info)
 # s/> // - remove '> ' prefix
 # s/< // - remove '< ' prefix
 else
 echo "No webhook url defined in 'vercel.$CUSTOMER_REF_TO_DEPLOY.staging.json:.build.env.VERCEL_DEPLOYMENT_COMPLETED_WEBHOOK' (found '$VERCEL_DEPLOYMENT_COMPLETED_WEBHOOK')"
 fi
Peter Mortensen
31.3k22 gold badges110 silver badges134 bronze badges
answered Dec 30, 2020 at 15:00

Comments

1
2

Start asking to get answers

Find the answer to your question by asking.

Ask question

Explore related questions

See similar questions with these tags.