Attach webhook

POSThttps://app.shuttleglobal.com/c/api/instances/{instance_key}/webhooks

Language

Credentials

Secret key

Instance keyRemember on this device

Kept in this browser tab unless you tick Remember; don't on a shared computer. Use keys from a sandbox account to test without moving money.

Parameters

Body application/json

cURL request

curl --request POST \
  --url https://app.shuttleglobal.com/c/api/instances/YOUR_INSTANCE_KEY/webhooks \
  --header 'Authorization: Basic <base64 of SECRET_KEY:>' \
  --header 'Content-Type: application/json' \
  --data '{
  "webhook": {
    "url": "https://your-app.com/webhooks/shuttle",
    "retries": 3
  }
}'

const url = 'https://app.shuttleglobal.com/c/api/instances/YOUR_INSTANCE_KEY/webhooks';
const options = {
  method: 'POST',
  headers: {
    Authorization: 'Basic <base64 of SECRET_KEY:>',
    'Content-Type': 'application/json'
  },
  body: '{"webhook":{"url":"https://your-app.com/webhooks/shuttle","retries":3}}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

import requests

url = "https://app.shuttleglobal.com/c/api/instances/YOUR_INSTANCE_KEY/webhooks"

payload = { "webhook": {
        "url": "https://your-app.com/webhooks/shuttle",
        "retries": 3
    } }
headers = {
    "Authorization": "Basic <base64 of SECRET_KEY:>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.json())

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://app.shuttleglobal.com/c/api/instances/YOUR_INSTANCE_KEY/webhooks', [
  'body' => '{
  "webhook": {
    "url": "https://your-app.com/webhooks/shuttle",
    "retries": 3
  }
}',
  'headers' => [
    'Authorization' => 'Basic <base64 of SECRET_KEY:>',
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();

require 'uri'
require 'net/http'

url = URI("https://app.shuttleglobal.com/c/api/instances/YOUR_INSTANCE_KEY/webhooks")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <base64 of SECRET_KEY:>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"webhook\": {\n    \"url\": \"https://your-app.com/webhooks/shuttle\",\n    \"retries\": 3\n  }\n}"

response = http.request(request)
puts response.read_body

package main

import (
  "fmt"
  "strings"
  "net/http"
  "io"
)

func main() {

  url := "https://app.shuttleglobal.com/c/api/instances/YOUR_INSTANCE_KEY/webhooks"

  payload := strings.NewReader("{\n  \"webhook\": {\n    \"url\": \"https://your-app.com/webhooks/shuttle\",\n    \"retries\": 3\n  }\n}")

  req, _ := http.NewRequest("POST", url, payload)

  req.Header.Add("Authorization", "Basic <base64 of SECRET_KEY:>")
  req.Header.Add("Content-Type", "application/json")

  res, _ := http.DefaultClient.Do(req)

  defer res.Body.Close()
  body, _ := io.ReadAll(res.Body)

  fmt.Println(res)
  fmt.Println(string(body))

}

curl --request POST \
  --url https://app.shuttleglobal.com/c/api/webhooks \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
  "webhook": {
    "url": "https://your-app.com/webhooks/shuttle",
    "retries": 3
  }
}'

const url = 'https://app.shuttleglobal.com/c/api/webhooks';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer YOUR_ACCESS_TOKEN', 'Content-Type': 'application/json'},
  body: '{"webhook":{"url":"https://your-app.com/webhooks/shuttle","retries":3}}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

import requests

url = "https://app.shuttleglobal.com/c/api/webhooks"

payload = { "webhook": {
        "url": "https://your-app.com/webhooks/shuttle",
        "retries": 3
    } }
headers = {
    "Authorization": "Bearer YOUR_ACCESS_TOKEN",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.json())

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://app.shuttleglobal.com/c/api/webhooks', [
  'body' => '{
  "webhook": {
    "url": "https://your-app.com/webhooks/shuttle",
    "retries": 3
  }
}',
  'headers' => [
    'Authorization' => 'Bearer YOUR_ACCESS_TOKEN',
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();

require 'uri'
require 'net/http'

url = URI("https://app.shuttleglobal.com/c/api/webhooks")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer YOUR_ACCESS_TOKEN'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"webhook\": {\n    \"url\": \"https://your-app.com/webhooks/shuttle\",\n    \"retries\": 3\n  }\n}"

response = http.request(request)
puts response.read_body

package main

import (
  "fmt"
  "strings"
  "net/http"
  "io"
)

func main() {

  url := "https://app.shuttleglobal.com/c/api/webhooks"

  payload := strings.NewReader("{\n  \"webhook\": {\n    \"url\": \"https://your-app.com/webhooks/shuttle\",\n    \"retries\": 3\n  }\n}")

  req, _ := http.NewRequest("POST", url, payload)

  req.Header.Add("Authorization", "Bearer YOUR_ACCESS_TOKEN")
  req.Header.Add("Content-Type", "application/json")

  res, _ := http.DefaultClient.Do(req)

  defer res.Body.Close()
  body, _ := io.ReadAll(res.Body)

  fmt.Println(res)
  fmt.Println(string(body))

}

Response

Webhook successfully attached

{
  "webhook": {
    "id": "5d41402abc4b2a76b9719d911017c592",
    "url": "https://your-app.com/webhooks/shuttle",
    "retries": 3
  }
}

POST

/webhooks

Adds a URL to the instance’s webhook_target, alongside any URLs already there (see Webhook configuration). Attaching a URL that is already attached updates its retries instead of adding it again.

Authorizations

basicAuth
bearerAuth

Request Body^required

application/json

object

webhook

required

object

url

required

string · uri

e.g. "https://your-app.com/webhooks/shuttle"

The HTTPS URL that will receive webhooks

retries

integer

e.g. 3

The total number of delivery attempts for each webhook, including the first. For example, 3 means the first attempt plus up to two retries. Leave it out (or send 0 or 1) for a single attempt with no retries.

Responses

200

Webhook successfully attached

application/json

object

webhook

object

string

e.g. "5d41402abc4b2a76b9719d911017c592"

Identifier for the attached URL. Use it to detach the webhook.

Pattern /^[a-f0-9]{32}$/

url

string · uri

e.g. "https://your-app.com/webhooks/shuttle"

The URL you attached

retries

integer

e.g. 3

The retries value you sent, if any

400

Bad request

application/json

Every error has a code and a message. Some add more fields alongside them, with detail about the error.

object

code

string

The error code, for example VALIDATION_ERROR, INVALID, INVALID_REQUEST, UNAUTHORIZED, FORBIDDEN or NOT_FOUND. Program against this, not the message.

message

string

What went wrong, in words, for logs and support.

401

Authentication required

application/json

Every error has a code and a message. Some add more fields alongside them, with detail about the error.

object

code

string

The error code, for example VALIDATION_ERROR, INVALID, INVALID_REQUEST, UNAUTHORIZED, FORBIDDEN or NOT_FOUND. Program against this, not the message.

message

string

What went wrong, in words, for logs and support.

Example

{
  "code": "UNAUTHORIZED",
  "message": "Unauthorised"
}

Was this page helpful?

Attach webhook

Authorizations

Request Bodyrequired

Responses

200

400

401

Request Body^required