Webhooks | Notion

The Romify webhook interface assists our SaaS platform with sending real-time data to external systems whenever a specific event occurs.

By configuring outgoing webhooks, your system can receive immediate notifications when relevant actions are triggered within our platform, streamlining data synchronization and automation.

Webhooks reduce the need for constant polling by pushing data to your endpoints, ensuring timely updates and efficient workflows.

Subscribing a Romify Webhook

https://hub.romify.io/api/v1/subscribewebhook

parameter	required	value	example
hookUrl	required	URL for the webhook	https://hooks.zapier.com/hooks/standard/12345434543/34543454

curl -X POST <https://hub.romify.io/api/v1/subscribewebhook> \\
  -H "Authorization: Bearer <your token>" \\
  -H "Content-Type: application/json" \\
  -d '{"hookUrl": "https://<url of the webhook>"}'

Returns: APIv1Webhook

Unsubscribing a Romify Webhook

https://hub.romify.io/api/v1/unsubscribewebhook

parameter	required	value	example
hookUrl	optional*	URL for the webhook. Either URL or Id is required.	https://hooks.zapier.com/hooks/standard/12345434543/34543454
hookId	optional*	Id of the webhook.	2342342-232342-23423-2-42342

curl -X POST <https://hub.romify.io/api/v1/unsubscribewebhook> \\
  -H "Authorization: Bearer <your token>" \\
  -H "Content-Type: application/json" \\
  -d '{
	  "hookUrl": "https://<url of the webhook>",
		"hookId": "<id of the webhook>",
	}'

Returns: APIv1Webhook

Data Sent by Webhooks

For Webhook types starting with:

COMPLETED_FLOW… send an APIv1Lead.
EVENT… send an APIv1Event.

Schema

**APIv1Webhook** {
  id: string;
  webhookURL: string;
  enabled: boolean;
  name?: string;
  automaticUploadDisabled?: boolean;
  webhookType: APIv1WebhookType;
  headers?: {
    [key: string]: string;
  };
  queryParams?: {
    [key: string]: string;
  };
  bodyParams?: {
    [key: string]: string;
  };
  method: 'POST' | 'GET' | 'PUT' | 'DELETE';
}

**APIv1WebhookType** {
  | COMPLETED_FLOW_ALL_CHANGES // Every time a lead is scanned or changed
  | EVENT_STARTING_SOON // Event is due to startt in 3 days
  | EVENT_STARTS // Event started now and its status is LIVE
  | EVENT_ENDS // Event ended now and its status is COMPLETED
}