WebMini API

Global API Functions

Introduction

This page lists API functions that work with every WebMini service.

Possible values for {service} currently are: sitesmakeritemplatform

List Service Accounts

GET https://my.webmini.com/api/v1/{service}/accounts

Required scope: {service}:read

Response

HTTP/1.1 200 OK

[
	{
		"id": 12345678,
		"name": "Account Name",
		"admin": true
	}
]

Webhooks API

Each WebMini service supports creating, listing and deleting webhooks via API. For more information on how to correctly receive and process webhooks as well as webhook HTTP headers, please read our webhooks documentation. If you are just planning to add very few webhooks, please note that you can also manually create webhooks without ever having to use the API.

List Webhooks

GET https://my.webmini.com/api/v1/{service}/{account}/hooks

{service} has to be one of the WebMini service names{account} has to be the account ID of the account of which all webhooks should be listed.

Required scope: {service}:read

Response

HTTP/1.1 200 OK

[
	{
		"id": 12345,
		"event": "event_name",
		"source": "api",
		"type": "web",
		"url": "https://www.yourapp.com/webhook/",
		"date_created": "2015-06-16T13:35:59Z"
	}
]

A complete list of possible event names for a WebMini service can be found on its specific service API documentation page.

Create Webhook

POST https://my.webmini.com/api/v1/{service}/{account}/hooks

{service} has to be one of the WebMini service names{account} has to be the account ID of the account the webhook is being created for.

Required scope: {service}:read (This is an exception: the read scope is sufficient for creating hooks.)

Parameters

Name Type Description
event String Required. Determines the event the hook is triggered for. A complete list of possible event names for a WebMini service can be found on its specific service API documentation page.
target_url String Required. Defines the URL to which the payloads will be delivered.

Response

HTTP/1.1 201 Created

{
	"id": 12345
}

Delete Webhook

DELETE https://my.webmini.com/api/v1/{service}/hooks/{hook}

{service} has to be one of the WebMini service names. {hook} has to be the ID of the hook that should be deleted.

Required scope: {service}:read (This is an exception: the read scope is sufficient for deleting hooks.)

Response

HTTP/1.1 204 No Content