Subscribe to an app event

POST

integrations

{id}

triggers

import { createClient } from "@norbelys/sdk";

const norbelys = createClient({ apiKey: process.env.NORBELYS_API_KEY });

const { data, error } = await norbelys.integrations.triggers.add("int_9k4m2p", { event: "HUBSPOT_NEW_CONTACT" });
if (error) {
  throw new Error(error.error.message);
}
console.log(data);

{
  "config": {
    "interval": 60
  },
  "enabled": true,
  "event": "HUBSPOT_NEW_CONTACT",
  "id": "intt_p2q8r4s0t6u2v8w4x0y6z2a8",
  "createdAt": "<unknown>",
  "object": "integration_trigger"
}

{
  "error": {
    "code": "invalid_param",
    "message": "<string>",
    "type": "invalid_request",
    "doc_url": "<string>",
    "hint": "<string>"
  }
}

{
  "error": {
    "code": "invalid_param",
    "message": "<string>",
    "type": "invalid_request",
    "doc_url": "<string>",
    "hint": "<string>"
  }
}

{
  "error": {
    "code": "invalid_param",
    "message": "<string>",
    "type": "invalid_request",
    "doc_url": "<string>",
    "hint": "<string>"
  }
}

{
  "error": {
    "code": "invalid_param",
    "message": "<string>",
    "type": "invalid_request",
    "doc_url": "<string>",
    "hint": "<string>"
  }
}

{
  "error": {
    "code": "invalid_param",
    "message": "<string>",
    "type": "invalid_request",
    "doc_url": "<string>",
    "hint": "<string>"
  }
}

{
  "error": {
    "code": "invalid_param",
    "message": "<string>",
    "type": "invalid_request",
    "doc_url": "<string>",
    "hint": "<string>"
  }
}

{
  "error": {
    "code": "invalid_param",
    "message": "<string>",
    "type": "invalid_request",
    "doc_url": "<string>",
    "hint": "<string>"
  }
}

{
  "error": {
    "code": "invalid_param",
    "message": "<string>",
    "type": "invalid_request",
    "doc_url": "<string>",
    "hint": "<string>"
  }
}

Authorizations

Authorization

string

header

required

Org-scoped Norbelys API key. Create one in Settings → API keys and send it as Authorization: Bearer ak_….

Headers

Idempotency-Key

string

Opt-in idempotency for a safely retried write: reuse the same key to replay the original result for 24h instead of re-executing. Recommended on every POST.

Maximum string length: 255

Path Parameters

string

required

The integration id (path).

Body

application/json

event

string

required

The event slug to subscribe to.

Example:

"HUBSPOT_NEW_CONTACT"

config

object

Configuration for this event, when it takes one (see GET /v1/integrations/{id}/events).

Show child attributes

Example:

{ "interval": 60 }

Response

config

object | null

required

The trigger's configuration, or null when it takes none.

Show child attributes

Example:

{ "interval": 60 }

enabled

boolean

required

False while the trigger is paused.

event

string

required

The event slug this trigger listens to.

Example:

"HUBSPOT_NEW_CONTACT"

string

required

The trigger id.

Example:

"intt_p2q8r4s0t6u2v8w4x0y6z2a8"

createdAt

any

When the trigger was created (RFC 3339).

object

any

default:integration_trigger

Always "integration_trigger".

import { createClient } from "@norbelys/sdk";

const norbelys = createClient({ apiKey: process.env.NORBELYS_API_KEY });

const { data, error } = await norbelys.integrations.triggers.add("int_9k4m2p", { event: "HUBSPOT_NEW_CONTACT" });
if (error) {
  throw new Error(error.error.message);
}
console.log(data);

{
  "config": {
    "interval": 60
  },
  "enabled": true,
  "event": "HUBSPOT_NEW_CONTACT",
  "id": "intt_p2q8r4s0t6u2v8w4x0y6z2a8",
  "createdAt": "<unknown>",
  "object": "integration_trigger"
}

{
  "error": {
    "code": "invalid_param",
    "message": "<string>",
    "type": "invalid_request",
    "doc_url": "<string>",
    "hint": "<string>"
  }
}

{
  "error": {
    "code": "invalid_param",
    "message": "<string>",
    "type": "invalid_request",
    "doc_url": "<string>",
    "hint": "<string>"
  }
}

{
  "error": {
    "code": "invalid_param",
    "message": "<string>",
    "type": "invalid_request",
    "doc_url": "<string>",
    "hint": "<string>"
  }
}

{
  "error": {
    "code": "invalid_param",
    "message": "<string>",
    "type": "invalid_request",
    "doc_url": "<string>",
    "hint": "<string>"
  }
}

{
  "error": {
    "code": "invalid_param",
    "message": "<string>",
    "type": "invalid_request",
    "doc_url": "<string>",
    "hint": "<string>"
  }
}

{
  "error": {
    "code": "invalid_param",
    "message": "<string>",
    "type": "invalid_request",
    "doc_url": "<string>",
    "hint": "<string>"
  }
}

{
  "error": {
    "code": "invalid_param",
    "message": "<string>",
    "type": "invalid_request",
    "doc_url": "<string>",
    "hint": "<string>"
  }
}

{
  "error": {
    "code": "invalid_param",
    "message": "<string>",
    "type": "invalid_request",
    "doc_url": "<string>",
    "hint": "<string>"
  }
}

Analytics

Domains

Fields

Files

Groups

Integrations

Messages

Organization

People

Programs

Segments

Senders

Suppressions

Verify

Subscribe to an app event

Authorizations

Headers

Path Parameters

Body

Response