Create a new webhook endpoint
1 min
POST
https://api.nue.io/webhook-endpoints
Header Parameters
- acceptstringDescriptionDefaultapplication/jsonAllowedapplication/json*/*
Body Parameters
- bodyCreateEventTypeRegistrationRequestrequired
Responses
200
- CreateEventTypeRegistrationResponse
400
404
500
curl
curl --request POST \
--url https://api.nue.io/webhook-endpoints \
--header 'accept: application/json'javascript
var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
var requestOptions = {
method: 'POST',
headers: myHeaders,
redirect: 'follow'
};
fetch("https://api.nue.io/webhook-endpoints", requestOptions)
.then(response => response.text())
.then(result => console.log(result))
.catch(error => console.log('error', error));ruby
require "uri"
require "net/http"
url = URI("https://api.nue.io/webhook-endpoints")
https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true
request = Net::HTTP::Post.new(url)
request["accept"] = "application/json"
response = https.request(request)
puts response.read_body
python
import requests
url = "https://api.nue.io/webhook-endpoints"
payload = {}
headers = {
'accept': 'application/json'
}
response = requests.request("POST", url, headers=headers, data=payload)
print(response.text)
200
// Successfully created webhook endpoint
{}GENERATED
// Successfully created webhook endpoint
{}Webhook Created Successfully
{
"id": "e4db815d-f8cb-4d51-b729-6417fb1296ee",
"name": "first webhook",
"object": "webhook_endpoint",
"createdDate": "2023-09-20T17:23:16.592+08:00",
"createdBy": "ca9d3479-79c8-4d5b-bee0-4d1100984830",
"lastModifiedDate": "2023-09-20T17:23:16.592+08:00",
"lastModifiedBy": "ca9d3479-79c8-4d5b-bee0-4d1100984830",
"description": "the description",
"status": "enabled",
"events": [
"invoice.activated",
"invoice.canceled",
"credit_memo.activated",
"credit_memo.canceled"
],
"endpoint": "https://mywebsite.com/endpoint"
}400
// Bad Request
404
// Not Found
500
// webhook endpoint url invalid
webhook endpoint url invalid
{
"title": "BAD_REQUEST",
"message": "A valid url is required for webhook: {{request:endpoint}}",
"errorCode": "INVALID_WEBHOOK_ENDPOINT_URL"
}