Skip to content
Baack
Book a stack auditBook an audit
Menu

Webhook Subscription

Representation of a webhook subscription to listen for events supported by the given subject

Browse the docs

Endpoints

  • GET/n/v1/webhooksubscription/{urn}

    Webhook subscription endpoint which supports the management of subscriptions at scale.

    Parameters

    urn (path, required)
    String representation of a Unique Resource Name. Typically a UUID with 36 characters.

    Responses

    200 OK
    returns Webhook SubscriptionREAD_SUCCESS
    404 Not found
    returns ErrorNOT_FOUND
    curl -H "Authorization: Bearer $BAACK_API_TOKEN" \
  https://api.baack.co/n/v1/webhooksubscription/{urn}

Fields

Webhook Subscription fields
FieldTypeDescription
urnstring (uuid)
apiClientAPI Client

Required on create.Ignored on update.

authstring

One of: BASIC, DIGEST, BEARER, HMAC_SHA256

subjectstring

Required on create.

One of: UNKNOWN, ADDRESS, API_CLIENT, BEARER_TOKEN, BOOLEAN_ITEM, CLIENT_IDENTIFIER, COMPANY, DATETIME_ITEM, DOUBLE_ITEM, EMAIL, ENTITY, ENTITY_LIST, GROUP, GROUP_MEMBERSHIP, IDENTITY, JSON_ITEM, LINK_ITEM, REFERENCE_ITEM, IMAGE_ITEM, LATLONG_ITEM, LONG_ITEM, MARKDOWN_ITEM, MESSAGE_THREAD, MESSAGE_THREAD_NOTIFICATION, MONEY_ITEM, OAUTH_TOKEN, PERMISSION, PERSON, PERSON_NAME, PROJECT, ROLE, TASK, TELEPHONE, TEMPLATE_ITEM, TEXT_ITEM, THREAD_POST, WEBHOOK_SUBSCRIPTION, WORKFLOW

eventsPerMinuteinteger (int32)

Required on create.

expirationTimestampstring (date-time)
destinationUrlstring (uri)

Required on create.

Up to 1024 characters.

secretstring (password)

Required on create.

eventstring

Required on create.

One of: ALL, CREATE, UPDATE, DELETE

urlstring (uri)

Used by: Webhook Event, Webhook Trigger