BokaMera.API.Host

<back to all web services

TestWebhookEndpoint

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin
The following routes are available for this service:
POST/webhook/endpoints/{Id}/testTest webhook endpoint by sending a sample message
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


@ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
// @ApiResponse(Description="Invalid request", StatusCode=400)
@ValidateRequest(Validator="IsAuthenticated")
open class TestWebhookEndpoint : ICompany
{
    /**
    * The company id, if empty will use the company id for the user you are logged in with.
    */
    @ApiMember(Description="The company id, if empty will use the company id for the user you are logged in with.", IsRequired=true, ParameterType="query")
    override var CompanyId:UUID? = null

    /**
    * The ID of the webhook endpoint to test.
    */
    @ApiMember(Description="The ID of the webhook endpoint to test.", IsRequired=true, ParameterType="path")
    open var Id:String? = null
}

open class TestWebhookEndpointResponse
{
    open var MessageId:String? = null
}

Kotlin TestWebhookEndpoint DTOs

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

HTTP + OTHER

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

POST /webhook/endpoints/{Id}/test HTTP/1.1 
Host: api.bokamera.se 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"CompanyId":"00000000-0000-0000-0000-000000000000","Id":"String"}
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"MessageId":"String"}