Create a workspace webhook

curl --request POST \
  --url https://wallet-sandbox.blockops.network/api/v1/workspaces/{workspace_id}/webhooks \
  --header 'ACCESS-API-KEY: <api-key>' \
  --header 'ACCESS-SIGN: <api-key>' \
  --header 'ACCESS-TIMESTAMP: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "url": "<string>",
  "endpoint_url": "<string>",
  "endpointUrl": "<string>",
  "events": [
    "<string>"
  ],
  "event_types": [
    "<string>"
  ],
  "eventTypes": [
    "<string>"
  ],
  "description": "<string>",
  "is_active": true,
  "isActive": true,
  "enabled": true
}
'

import requests

url = "https://wallet-sandbox.blockops.network/api/v1/workspaces/{workspace_id}/webhooks"

payload = {
    "url": "<string>",
    "endpoint_url": "<string>",
    "endpointUrl": "<string>",
    "events": ["<string>"],
    "event_types": ["<string>"],
    "eventTypes": ["<string>"],
    "description": "<string>",
    "is_active": True,
    "isActive": True,
    "enabled": True
}
headers = {
    "ACCESS-API-KEY": "<api-key>",
    "ACCESS-TIMESTAMP": "<api-key>",
    "ACCESS-SIGN": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'ACCESS-API-KEY': '<api-key>',
    'ACCESS-TIMESTAMP': '<api-key>',
    'ACCESS-SIGN': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    url: '<string>',
    endpoint_url: '<string>',
    endpointUrl: '<string>',
    events: ['<string>'],
    event_types: ['<string>'],
    eventTypes: ['<string>'],
    description: '<string>',
    is_active: true,
    isActive: true,
    enabled: true
  })
};

fetch('https://wallet-sandbox.blockops.network/api/v1/workspaces/{workspace_id}/webhooks', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://wallet-sandbox.blockops.network/api/v1/workspaces/{workspace_id}/webhooks",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'url' => '<string>',
    'endpoint_url' => '<string>',
    'endpointUrl' => '<string>',
    'events' => [
        '<string>'
    ],
    'event_types' => [
        '<string>'
    ],
    'eventTypes' => [
        '<string>'
    ],
    'description' => '<string>',
    'is_active' => true,
    'isActive' => true,
    'enabled' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "ACCESS-API-KEY: <api-key>",
    "ACCESS-SIGN: <api-key>",
    "ACCESS-TIMESTAMP: <api-key>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://wallet-sandbox.blockops.network/api/v1/workspaces/{workspace_id}/webhooks"

	payload := strings.NewReader("{\n  \"url\": \"<string>\",\n  \"endpoint_url\": \"<string>\",\n  \"endpointUrl\": \"<string>\",\n  \"events\": [\n    \"<string>\"\n  ],\n  \"event_types\": [\n    \"<string>\"\n  ],\n  \"eventTypes\": [\n    \"<string>\"\n  ],\n  \"description\": \"<string>\",\n  \"is_active\": true,\n  \"isActive\": true,\n  \"enabled\": true\n}")

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

	req.Header.Add("ACCESS-API-KEY", "<api-key>")
	req.Header.Add("ACCESS-TIMESTAMP", "<api-key>")
	req.Header.Add("ACCESS-SIGN", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://wallet-sandbox.blockops.network/api/v1/workspaces/{workspace_id}/webhooks")
  .header("ACCESS-API-KEY", "<api-key>")
  .header("ACCESS-TIMESTAMP", "<api-key>")
  .header("ACCESS-SIGN", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"url\": \"<string>\",\n  \"endpoint_url\": \"<string>\",\n  \"endpointUrl\": \"<string>\",\n  \"events\": [\n    \"<string>\"\n  ],\n  \"event_types\": [\n    \"<string>\"\n  ],\n  \"eventTypes\": [\n    \"<string>\"\n  ],\n  \"description\": \"<string>\",\n  \"is_active\": true,\n  \"isActive\": true,\n  \"enabled\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://wallet-sandbox.blockops.network/api/v1/workspaces/{workspace_id}/webhooks")

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

request = Net::HTTP::Post.new(url)
request["ACCESS-API-KEY"] = '<api-key>'
request["ACCESS-TIMESTAMP"] = '<api-key>'
request["ACCESS-SIGN"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"url\": \"<string>\",\n  \"endpoint_url\": \"<string>\",\n  \"endpointUrl\": \"<string>\",\n  \"events\": [\n    \"<string>\"\n  ],\n  \"event_types\": [\n    \"<string>\"\n  ],\n  \"eventTypes\": [\n    \"<string>\"\n  ],\n  \"description\": \"<string>\",\n  \"is_active\": true,\n  \"isActive\": true,\n  \"enabled\": true\n}"

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

{
  "success": true,
  "message": "success",
  "code": 0,
  "data": {
    "id": "<string>",
    "webhook_id": "<string>",
    "workspace_id": "<string>",
    "url": "<string>",
    "events": [
      "<string>"
    ],
    "status": "<string>",
    "is_active": true,
    "description": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  }
}

{
  "success": false,
  "message": "success",
  "code": 0,
  "data": null
}

{
  "success": false,
  "message": "invalid api signature",
  "code": "unauthorized",
  "data": null
}

{
  "success": false,
  "message": "success",
  "code": 0,
  "data": null
}

POST

api

workspaces

{workspace_id}

webhooks

Create a workspace webhook

curl --request POST \
  --url https://wallet-sandbox.blockops.network/api/v1/workspaces/{workspace_id}/webhooks \
  --header 'ACCESS-API-KEY: <api-key>' \
  --header 'ACCESS-SIGN: <api-key>' \
  --header 'ACCESS-TIMESTAMP: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "url": "<string>",
  "endpoint_url": "<string>",
  "endpointUrl": "<string>",
  "events": [
    "<string>"
  ],
  "event_types": [
    "<string>"
  ],
  "eventTypes": [
    "<string>"
  ],
  "description": "<string>",
  "is_active": true,
  "isActive": true,
  "enabled": true
}
'

import requests

url = "https://wallet-sandbox.blockops.network/api/v1/workspaces/{workspace_id}/webhooks"

payload = {
    "url": "<string>",
    "endpoint_url": "<string>",
    "endpointUrl": "<string>",
    "events": ["<string>"],
    "event_types": ["<string>"],
    "eventTypes": ["<string>"],
    "description": "<string>",
    "is_active": True,
    "isActive": True,
    "enabled": True
}
headers = {
    "ACCESS-API-KEY": "<api-key>",
    "ACCESS-TIMESTAMP": "<api-key>",
    "ACCESS-SIGN": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'ACCESS-API-KEY': '<api-key>',
    'ACCESS-TIMESTAMP': '<api-key>',
    'ACCESS-SIGN': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    url: '<string>',
    endpoint_url: '<string>',
    endpointUrl: '<string>',
    events: ['<string>'],
    event_types: ['<string>'],
    eventTypes: ['<string>'],
    description: '<string>',
    is_active: true,
    isActive: true,
    enabled: true
  })
};

fetch('https://wallet-sandbox.blockops.network/api/v1/workspaces/{workspace_id}/webhooks', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://wallet-sandbox.blockops.network/api/v1/workspaces/{workspace_id}/webhooks",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'url' => '<string>',
    'endpoint_url' => '<string>',
    'endpointUrl' => '<string>',
    'events' => [
        '<string>'
    ],
    'event_types' => [
        '<string>'
    ],
    'eventTypes' => [
        '<string>'
    ],
    'description' => '<string>',
    'is_active' => true,
    'isActive' => true,
    'enabled' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "ACCESS-API-KEY: <api-key>",
    "ACCESS-SIGN: <api-key>",
    "ACCESS-TIMESTAMP: <api-key>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://wallet-sandbox.blockops.network/api/v1/workspaces/{workspace_id}/webhooks"

	payload := strings.NewReader("{\n  \"url\": \"<string>\",\n  \"endpoint_url\": \"<string>\",\n  \"endpointUrl\": \"<string>\",\n  \"events\": [\n    \"<string>\"\n  ],\n  \"event_types\": [\n    \"<string>\"\n  ],\n  \"eventTypes\": [\n    \"<string>\"\n  ],\n  \"description\": \"<string>\",\n  \"is_active\": true,\n  \"isActive\": true,\n  \"enabled\": true\n}")

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

	req.Header.Add("ACCESS-API-KEY", "<api-key>")
	req.Header.Add("ACCESS-TIMESTAMP", "<api-key>")
	req.Header.Add("ACCESS-SIGN", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://wallet-sandbox.blockops.network/api/v1/workspaces/{workspace_id}/webhooks")
  .header("ACCESS-API-KEY", "<api-key>")
  .header("ACCESS-TIMESTAMP", "<api-key>")
  .header("ACCESS-SIGN", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"url\": \"<string>\",\n  \"endpoint_url\": \"<string>\",\n  \"endpointUrl\": \"<string>\",\n  \"events\": [\n    \"<string>\"\n  ],\n  \"event_types\": [\n    \"<string>\"\n  ],\n  \"eventTypes\": [\n    \"<string>\"\n  ],\n  \"description\": \"<string>\",\n  \"is_active\": true,\n  \"isActive\": true,\n  \"enabled\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://wallet-sandbox.blockops.network/api/v1/workspaces/{workspace_id}/webhooks")

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

request = Net::HTTP::Post.new(url)
request["ACCESS-API-KEY"] = '<api-key>'
request["ACCESS-TIMESTAMP"] = '<api-key>'
request["ACCESS-SIGN"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"url\": \"<string>\",\n  \"endpoint_url\": \"<string>\",\n  \"endpointUrl\": \"<string>\",\n  \"events\": [\n    \"<string>\"\n  ],\n  \"event_types\": [\n    \"<string>\"\n  ],\n  \"eventTypes\": [\n    \"<string>\"\n  ],\n  \"description\": \"<string>\",\n  \"is_active\": true,\n  \"isActive\": true,\n  \"enabled\": true\n}"

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

{
  "success": true,
  "message": "success",
  "code": 0,
  "data": {
    "id": "<string>",
    "webhook_id": "<string>",
    "workspace_id": "<string>",
    "url": "<string>",
    "events": [
      "<string>"
    ],
    "status": "<string>",
    "is_active": true,
    "description": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  }
}

{
  "success": false,
  "message": "success",
  "code": 0,
  "data": null
}

{
  "success": false,
  "message": "invalid api signature",
  "code": "unauthorized",
  "data": null
}

{
  "success": false,
  "message": "success",
  "code": 0,
  "data": null
}

Authorizations

ACCESS-API-KEY

string

header

required

HMAC API-key identifier.

ACCESS-TIMESTAMP

string

header

required

Unix timestamp in seconds.

ACCESS-SIGN

string

header

required

Base64-encoded hex HMAC signature.

Path Parameters

workspace_id

string

required

Body

application/json

url

string<uri>

endpoint_url

string<uri>

endpointUrl

string<uri>

events

string[]

event_types

string[]

eventTypes

string[]

description

string

is_active

boolean

isActive

boolean

enabled

boolean

Response

Created webhook subscription.

success

boolean

required

message

string

required

Example:

"success"

code

required

Example:

0

data

object

required

Show child attributes

Wallet API

Endpoints

Create a workspace webhook

Authorizations

Path Parameters

Body

Response