BokaMera.API.Host

<back to all web services

WebhookCreateAgreement

The following routes are available for this service:
POST/webhooks/termsWebhook from prismic
import Foundation
import ServiceStack

// @ApiResponse(Description="Returned if there is a validation error on the input parameters", StatusCode=400)
// @ApiResponse(Description="Returned if the current user is not allowed to perform the action", StatusCode=401)
public class WebhookCreateAgreement : Codable
{
    public var releases:Releases
    public var documents:[String] = []
    public var secret:String

    required public init(){}
}

public class Releases : Codable
{
    public var deletion:[WebhookAgreements] = []

    required public init(){}
}

public class WebhookAgreements : Codable
{
    public var id:String
    public var label:String
    public var documents:[String] = []

    required public init(){}
}


Swift WebhookCreateAgreement DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /webhooks/terms HTTP/1.1 
Host: testapi.bokamera.se 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	releases: 
	{
		deletion: 
		[
			{
				id: String,
				label: String,
				documents: 
				[
					String
				]
			}
		]
	},
	documents: 
	[
		String
	],
	secret: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	
}