Webhook (beta)

This API provides Webhook capabilities to developers on the SKY platform.

POST

Subscription test payload

Sends a test event payload to your subscription so you can verify your subscription's webhook behavior. This payload uses a special event type ('com.blackbaud.utility.testpayload.v1') so your webhook can identify the test.

Try it

Request URL

Request parameters

Parameter Required Type Description
subscription_id Property is required string

The subscription identifier

Request headers

Header Required Type Description
Bb-Api-Subscription-Key Property is required string Subscription key which provides access to this API. Found in your Profile.
Authorization Property is required string OAuth 2.0 access token obtained from Blackbaud OAuth 2.0 Service. Supported grant types: Authorization code, Implicit.

Response 200 OK

Returned when the webhook test payload is successfully delivered to the subscription webhook URL.

Response 404 Not Found

Returned when no subscription is found by the specified subscription_id in the environmet determined by your SKY API access token.

[
  {
    "message": "The requested item could not be found.",
    "error_name": "Not Found",
    "error_code": 404,
    "raw_message": "The requested item could not be found."
  }
]
{
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "message": {
        "type": "string",
        "nullable": true
      },
      "error_name": {
        "type": "string",
        "nullable": true
      },
      "error_code": {
        "type": "integer",
        "format": "int32"
      },
      "raw_message": {
        "type": "string",
        "nullable": true
      },
      "error_args": {
        "type": "array",
        "items": {
          "type": "string"
        },
        "nullable": true
      }
    },
    "additionalProperties": false
  }
}

Response 400 Bad Request

Returned when the specified request parameters are not provided.

[
  {
    "message": "Your webhook returned an invalid HTTP status code when sent the test event payload. Received status code: 400. Expected: 200 - 204.",
    "error_name": "Bad Request",
    "error_code": 20005,
    "raw_message": "Your webhook returned an invalid HTTP status code when sent the test event payload. Received status code: 400. Expected: 200 - 204."
  }
]
{
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "message": {
        "type": "string",
        "nullable": true
      },
      "error_name": {
        "type": "string",
        "nullable": true
      },
      "error_code": {
        "type": "integer",
        "format": "int32"
      },
      "raw_message": {
        "type": "string",
        "nullable": true
      },
      "error_args": {
        "type": "array",
        "items": {
          "type": "string"
        },
        "nullable": true
      }
    },
    "additionalProperties": false
  }
}

Response 403 Forbidden

Returned when your application does not have permission to view the subscription.

[
  {
    "message": "This application does not have the necessary permissions to perform this task.",
    "error_name": "Forbidden",
    "error_code": 403,
    "raw_message": "This application does not have the necessary permissions to perform this task."
  }
]
{
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "message": {
        "type": "string",
        "nullable": true
      },
      "error_name": {
        "type": "string",
        "nullable": true
      },
      "error_code": {
        "type": "integer",
        "format": "int32"
      },
      "raw_message": {
        "type": "string",
        "nullable": true
      },
      "error_args": {
        "type": "array",
        "items": {
          "type": "string"
        },
        "nullable": true
      }
    },
    "additionalProperties": false
  }
}

Code samples

@ECHO OFF

curl -v -X POST "https://api.sky.blackbaud.com/webhook/v1/utilities/subscriptions/{subscription_id}/testpayload"
-H "Bb-Api-Subscription-Key: {subscription key}"
-H "Authorization: Bearer {access token}"
--data-ascii "{body}"
using System;
using System.Net.Http.Headers;
using System.Text;
using System.Net.Http;
using System.Web;

namespace CSHttpClientSample
{
    static class Program
    {
        static void Main()
        {
            MakeRequest();
            Console.WriteLine("Hit ENTER to exit...");
            Console.ReadLine();
        }

        static async void MakeRequest()
        {
            var client = new HttpClient();
            var queryString = HttpUtility.ParseQueryString(string.Empty);

            // Request headers
            client.DefaultRequestHeaders.Add("Bb-Api-Subscription-Key", "{subscription key}");
            client.DefaultRequestHeaders.Add("Authorization", "Bearer {access token}");

            var uri = "https://api.sky.blackbaud.com/webhook/v1/utilities/subscriptions/{subscription_id}/testpayload?" + queryString;

            // Request body
            byte[] byteData = Encoding.UTF8.GetBytes("{body}");

            using (var content = new ByteArrayContent(byteData))
            {
               content.Headers.ContentType = new MediaTypeHeaderValue("< your content type, i.e. application/json >");
               var response = await client.PostAsync(uri, content);
            }

        }
    }
}
// // This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
import java.net.URI;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.client.utils.URIBuilder;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;

public class JavaSample 
{
    public static void main(String[] args) 
    {
        HttpClient httpclient = HttpClients.createDefault();

        try
        {
            URIBuilder builder = new URIBuilder("https://api.sky.blackbaud.com/webhook/v1/utilities/subscriptions/{subscription_id}/testpayload");


            URI uri = builder.build();
            HttpPost request = new HttpPost(uri);
            request.setHeader("Bb-Api-Subscription-Key", "{subscription key}");
            request.setHeader("Authorization", "Bearer {access token}");

            // Request body
            StringEntity reqEntity = new StringEntity("{body}");
            request.setEntity(reqEntity);

            HttpResponse response = httpclient.execute(request);
            HttpEntity entity = response.getEntity();

            if (entity != null) 
            {
                System.out.println(EntityUtils.toString(entity)); 
            }
        }
        catch (Exception e)
        {
            System.out.println(e.getMessage());
        }
    }
}

<!DOCTYPE html>
<html>
<head>
    <title>JSSample</title>
    <script src="http://ajax.googleapis.com/ajax/libs/jquery/1.9.0/jquery.min.js"></script>
</head>
<body>

<script type="text/javascript">
    $(function() {
        var params = {
            // Request parameters
        };

        $.ajax({
            url: "https://api.sky.blackbaud.com/webhook/v1/utilities/subscriptions/{subscription_id}/testpayload?" + $.param(params),
            beforeSend: function(xhrObj){
                // Request headers
                xhrObj.setRequestHeader("Bb-Api-Subscription-Key","{subscription key}");
                xhrObj.setRequestHeader("Authorization","Bearer {access token}");
            },
            type: "POST",
            // Request body
            data: "{body}",
        })
        .done(function(data) {
            alert("success");
        })
        .fail(function() {
            alert("error");
        });
    });
</script>
</body>
</html>
#import <Foundation/Foundation.h>

int main(int argc, const char * argv[])
{
    NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];

    NSString* path = @"https://api.sky.blackbaud.com/webhook/v1/utilities/subscriptions/{subscription_id}/testpayload";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                      ];

    NSString* string = [array componentsJoinedByString:@"&"];
    path = [path stringByAppendingFormat:@"?%@", string];

    NSLog(@"%@", path);

    NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
    [_request setHTTPMethod:@"POST"];
    // Request headers
    [_request setValue:@"{subscription key}" forHTTPHeaderField:@"Bb-Api-Subscription-Key"];
    [_request setValue:@"Bearer {access token}" forHTTPHeaderField:@"Authorization"];
    // Request body
    [_request setHTTPBody:[@"{body}" dataUsingEncoding:NSUTF8StringEncoding]];

    NSURLResponse *response = nil;
    NSError *error = nil;
    NSData* _connectionData = [NSURLConnection sendSynchronousRequest:_request returningResponse:&response error:&error];

    if (nil != error)
    {
        NSLog(@"Error: %@", error);
    }
    else
    {
        NSError* error = nil;
        NSMutableDictionary* json = nil;
        NSString* dataString = [[NSString alloc] initWithData:_connectionData encoding:NSUTF8StringEncoding];
        NSLog(@"%@", dataString);

        if (nil != _connectionData)
        {
            json = [NSJSONSerialization JSONObjectWithData:_connectionData options:NSJSONReadingMutableContainers error:&error];
        }

        if (error || !json)
        {
            NSLog(@"Could not parse loaded json with error:%@", error);
        }

        NSLog(@"%@", json);
        _connectionData = nil;
    }

    [pool drain];

    return 0;
}
<?php
// This sample uses the PEAR HTTP client from http://pear.php.net/package/HTTP_Request2
require_once 'HTTP/Request2.php';

$request = new Http_Request2('https://api.sky.blackbaud.com/webhook/v1/utilities/subscriptions/{subscription_id}/testpayload');
$url = $request->getUrl();

$headers = array(
    // Request headers
   'Bb-Api-Subscription-Key' => '{subscription key}',
   'Authorization' => 'Bearer {access token}',
);

$request->setHeader($headers);

$parameters = array(
    // Request parameters
);

$url->setQueryVariables($parameters);

$request->setMethod(HTTP_Request2::METHOD_POST);

// Request body
$request->setBody("{body}");

try
{
    $response = $request->send();
    echo $response->getBody();
}
catch (HttpException $ex)
{
    echo $ex;
}

?>
########### Python 2.7 #############
import httplib, urllib, base64

headers = {
    # Request headers
    'Bb-Api-Subscription-Key': '{subscription key}',
    'Authorization': 'Bearer {access token}',
}

params = urllib.urlencode({
})

try:
    conn = httplib.HTTPSConnection('api.sky.blackbaud.com')
    conn.request("POST", "/webhook/v1/utilities/subscriptions/{subscription_id}/testpayload?%s" % params, "{body}", headers)
    response = conn.getresponse()
    data = response.read()
    print(data)
    conn.close()
except Exception as e:
    print("[Errno {0}] {1}".format(e.errno, e.strerror))

####################################

########### Python 3.2 #############
import http.client, urllib.request, urllib.parse, urllib.error, base64

headers = {
    # Request headers
    'Bb-Api-Subscription-Key': '{subscription key}',
    'Authorization': 'Bearer {access token}',
}

params = urllib.parse.urlencode({
})

try:
    conn = http.client.HTTPSConnection('api.sky.blackbaud.com')
    conn.request("POST", "/webhook/v1/utilities/subscriptions/{subscription_id}/testpayload?%s" % params, "{body}", headers)
    response = conn.getresponse()
    data = response.read()
    print(data)
    conn.close()
except Exception as e:
    print("[Errno {0}] {1}".format(e.errno, e.strerror))

####################################
require 'net/http'

uri = URI('https://api.sky.blackbaud.com/webhook/v1/utilities/subscriptions/{subscription_id}/testpayload')

request = Net::HTTP::Post.new(uri.request_uri)

# Request headers
request['Bb-Api-Subscription-Key'] = '{subscription key}'
request['Authorization'] = 'Bearer {access token}'

# Request body
request.body = "{body}"

response = Net::HTTP.start(uri.host, uri.port, :use_ssl => uri.scheme == 'https') do |http|
    http.request(request)
end

puts response.body

Comments

Have a question? See a problem with our docs? Want to engage with the SKY Developer team? Please visit us on the SKY Developer Community!