Create a new webhook subscription - cobra CRM Cloud

Request

Header Params

X-Integration-Name

string

required

Integration name

Example:

API Documentation

X-Integration-Provider

string

required

Integration provider

Example:

cobra GmbH

X-Cobra-TenantId

string

required

Tenant ID

Example:

12e39e53-ece1-4d8d-8958-e782de1dbef0

X-Integration-Contact

string

optional

Integration contact

Example:

info@cobra.de

Body Params application/json

caption

string

required

Caption

>= 1 characters

Example:

My subscription

webhookId

string <uuid>

required

Webhook ID

>= 1 characters

Example:

80f48afa-4927-43de-9d0d-24cf4aba53cf

method

enum<string>

required

Allowed values:

POSTGET

url

string

required

Webhook URL

>= 1 characters

Example:

https://www.cobra.de

errorEmail

string <email>

required

E-mail for error notifications

>= 1 characters

Example:

error@cobra.de

payload

string | null

optional

JSON-Payload (must be valid JSON)

headers

object | null

optional

HTTP-Headers (Header names must be valid)

Additional properties

string | null

optional

Example

{
    "caption": "Event created",
    "webhookId": "80f48afa-4927-43de-9d0d-24cf4aba53cf",
    "method": "POST",
    "url": "https://www.mytesturl.de",
    "errorEmail": "error@cobra.de",
    "payload": "{\"firstName\": \"John\",\"lastName\": \"Doe\",\"EventNumber\": \"<EventNumber>\"}",
    "headers": {
        "MyHeader1": "HeaderValue1",
        "MyHeader2": "HeaderValue2"
    }
}

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'https://api.cobra.de/v1/subscriptions' \
--header 'X-Integration-Name: API Documentation' \
--header 'X-Integration-Provider: cobra GmbH' \
--header 'X-Cobra-TenantId: 12e39e53-ece1-4d8d-8958-e782de1dbef0' \
--header 'Content-Type: application/json' \
--data-raw '{
    "caption": "Event created",
    "webhookId": "80f48afa-4927-43de-9d0d-24cf4aba53cf",
    "method": "POST",
    "url": "https://www.mytesturl.de",
    "errorEmail": "error@cobra.de",
    "payload": "{\"firstName\": \"John\",\"lastName\": \"Doe\",\"EventNumber\": \"<EventNumber>\"}",
    "headers": {
        "MyHeader1": "HeaderValue1",
        "MyHeader2": "HeaderValue2"
    }
}'

Responses

🟢201Created

application/json

Created

Body

data

object (Subscription)

optional

Indicates the current subscription for the tenant

tariff

string <uuid>

optional

Tariff Id

Example:

95e95b33-6e9c-402d-beae-b0d06c74b199

tariffVersion

integer <int32>

optional

Tariff version

Example:

1

trial

boolean

optional

Indicates whether the tenant is in trial mode

Example:

false

trialEnd

string <date-time> | null

optional

Indicates when the trial mode ends

Example:

2024-01-10T15:06:25.355Z

lockout

boolean

optional

Indicates whether the tenant is locked

Example:

false

lockoutReason

enum<string>

optional

Allowed values:

EmptyTrialExpiredPaymentIssueSubscriptionDeleted

subscriptionId

string | null

optional

Subscription identifier which is active for the tenant

customerId

string | null

optional

Customer identifier which is assigned to the tenant

connectAccountId

string | null

optional

If the tenant is connected to a cobra partner, this is the id to the partners account. Otherwise it is empty.

daysLeft

integer <int32>

read-onlyoptional

If it is a trial version, the remaining days of the trial version are displayed here

message

string | null

optional

metaData

object (ResponseMetaData)

optional

totalResults

integer <int32>

optional

responseTimeStamp

string <date-time>

optional

statusCode

integer <int32>

optional

Example

{
    "data": {
        "id": "52fa5344-a28a-4866-84ce-798e4ff19341",
        "dateCreate": "2024-10-09T07:00:39.1309318+00:00",
        "dateModified": "2024-10-09T07:00:39.1309326+00:00",
        "caption": "Event created",
        "webhookId": "80f48afa-4927-43de-9d0d-24cf4aba53cf",
        "method": "POST",
        "url": "https://www.mytesturl.de",
        "errorEmail": "error@cobra.de",
        "payload": "{\"firstName\": \"John\",\"lastName\": \"doe\",\"EventNumber\": \"<EventNumber>\"}",
        "headers": {
            "MyHeader1": "HeaderValue1",
            "MyHeader2": "HeaderValue2"
        }
    },
    "message": "",
    "metaData": null,
    "statusCode": 200
}

🟠404Record Not Found