DEVEXP-1391: Implement Provisioning API - Webhooks by Hurus111 · Pull Request #259 · sinch/sinch-sdk-node

Hurus111 · 2026-06-18T10:29:06Z

No description provided.

…h Webhooks API and related configurations

…ndling

…Webhooks API functionality

…Api export

… package.json

…ckage.json

JPPortier · 2026-06-19T15:56:07Z

+  const webhookTarget = process.env.WEBHOOK_TARGET ?? 'https://example.com/webhook';
+  const webhookSecret = process.env.WEBHOOK_SECRET ?? 'MY_WEBHOOK_SECRET';


For these variables, values should come from source itself and to enforce proper values not defaulting to any value if not set:

Suggested change

const webhookTarget = process.env.WEBHOOK_TARGET ?? 'https://example.com/webhook';

const webhookSecret = process.env.WEBHOOK_SECRET ?? 'MY_WEBHOOK_SECRET';

// The URL called by Sinch when sending event

const webhookTarget = 'MY_WEBHOOK_URL';

// The secret to be used to validate event

const webhookSecret = 'MY_WEBHOOK_SECRET';

JPPortier · 2026-06-19T15:57:39Z

+  const projectId = process.env.SINCH_PROJECT_ID ?? 'MY_PROJECT_ID';
+  const keyId = process.env.SINCH_KEY_ID ?? 'MY_KEY_ID';
+  const keySecret = process.env.SINCH_KEY_SECRET ?? 'MY_KEY_SECRET';
+  const webhookId = process.env.WEBHOOK_ID ?? 'WEBHOOK_ID';


(see other snippets about what could be related to process.env and what is not, e.g.: https://github.com/sinch/sinch-sdk-node/blob/DEVEXP-1391-Implement-PAPI-Webhooks/examples/snippets/conversation/webhooks/get.js)

Suggested change

const webhookId = process.env.WEBHOOK_ID ?? 'WEBHOOK_ID';

// The ID of the Webhook to retrieve

const webhookId = 'WEBHOOK_ID';

JPPortier · 2026-06-19T15:59:59Z

+    const response = await sinch.provisioning.webhooks.list({
+      pageSize: 15,
+    });


We avoid from snippets to define this parameters: in the past we saw that humans/AI are using out of the box these parameters in production.
Better to have here :

Suggested change

const response = await sinch.provisioning.webhooks.list({

pageSize: 15,

});

const response = await sinch.provisioning.webhooks.list();

JPPortier · 2026-06-19T16:02:37Z

+  const projectId = process.env.SINCH_PROJECT_ID ?? 'MY_PROJECT_ID';
+  const keyId = process.env.SINCH_KEY_ID ?? 'MY_KEY_ID';
+  const keySecret = process.env.SINCH_KEY_SECRET ?? 'MY_KEY_SECRET';
+  const webhookId = process.env.WEBHOOK_ID ?? 'WEBHOOK_ID';


Suggested change

const webhookId = process.env.WEBHOOK_ID ?? 'WEBHOOK_ID';

// The ID of the Webhook to delete

const webhookId = 'WEBHOOK_ID';

JPPortier · 2026-06-19T16:02:56Z

+  const webhookId = process.env.WEBHOOK_ID ?? 'WEBHOOK_ID';
+  const webhookTarget = process.env.WEBHOOK_TARGET ?? 'https://example.com/webhook';
+  const webhookSecret = process.env.WEBHOOK_SECRET ?? 'MY_WEBHOOK_SECRET';


Suggested change

const webhookId = process.env.WEBHOOK_ID ?? 'WEBHOOK_ID';

const webhookTarget = process.env.WEBHOOK_TARGET ?? 'https://example.com/webhook';

const webhookSecret = process.env.WEBHOOK_SECRET ?? 'MY_WEBHOOK_SECRET';

// The ID of the Webhook to retrieve

const webhookId = 'WEBHOOK_ID';

// The URL called by Sinch when sending event

const webhookTarget = 'MY_WEBHOOK_URL';

// The secret to be used to validate event

const webhookSecret = 'MY_WEBHOOK_SECRET';

JPPortier · 2026-06-22T10:22:29Z

+  | 'WHATSAPP_TEMPLATE_DELETED'
+  | 'WHATSAPP_TEMPLATE_QUALITY_SCORE_UPDATED'
+  | 'WHATSAPP_TEMPLATE_REJECTED'
+  | 'WHATSAPP_TEMPLATE_STATUS_UPDATED';


Add | string to accept any new values

JPPortier · 2026-06-22T13:18:31Z

+   * Returns a paginated list of webhooks for the specified project.
+   * @param { ListWebhooksRequestData } data - The data to provide to the API call.
+   */
+  public async list(data: ListWebhooksRequestData): Promise<ListWebhooksResponse> {


Think it should be a ApiListPromise<ListWebhooksResponse> (e.g.: https://github.com/sinch/sinch-sdk-node/blob/DEVEXP-1391-Implement-PAPI-Webhooks/packages/numbers/src/rest/v1/active-number/active-number-api.ts)

JPPortier · 2026-06-22T13:27:41Z

+        ],
+      };
+
+      fixture.list.mockResolvedValue(expectedResponse);


To be checked against result wrapped with auto-pagination

JPPortier · 2026-06-22T13:30:01Z

+  webhooksList = await webhooksApi.list({
+    pageSize: 15,
+  });
+});


e2e tests should also cover the auto-pagination feature from SDK (e.g.: https://github.com/sinch/sinch-sdk-node/blob/DEVEXP-1391-Implement-PAPI-Webhooks/packages/sms/tests/rest/v1/batches/batches.steps.ts#L179-L206)

JPPortier · 2026-06-22T13:32:22Z

+Then('the response contains the provisioning webhook details', () => {
+  assert.equal(webhook.id, '01PROVWEBHOOK001');
+  assert.equal(webhook.target, 'https://my-callback-server.com/provisioning-all');
+  assert.deepEqual(webhook.triggers, ['ALL']);
+});


Specs also define projectId as part of the response.

…nt variable dependencies

…erface

…djust related tests

….5.0

JPPortier

We can suppose main README will have to be updated: https://github.com/sinch/sinch-sdk-node/tree/DEVEXP-1391-Implement-PAPI-Webhooks#supported-apis

JPPortier · 2026-07-23T09:36:42Z

+  // The URL called by Sinch when sending event
+  const webhookTarget = 'MY_WEBHOOK_URL';
+  // The secret to be used to validate event
+  const webhookSecret = 'MY_WEBHOOK_SECRET';


NEW_WEBHOOK_SECRET ? (e.g: https://github.com/sinch/sinch-sdk-node/blob/v1.6-next/examples/snippets/numbers/callback-configuration/update.js#L15)

JPPortier · 2026-07-23T09:37:51Z

+  const keySecret = process.env.SINCH_KEY_SECRET ?? 'MY_KEY_SECRET';
+
+  // The URL called by Sinch when sending event
+  const webhookTarget = 'MY_WEBHOOK_URL';


See existing snippets to have common pattern about values:

https://github.com/sinch/sinch-sdk-node/blob/v1.6-next/examples/snippets/conversation/webhooks/create.js#L24

https://github.com/sinch/sinch-sdk-node/blob/v1.6-next/examples/snippets/voice/applications/update-callback-urls.js#L14

JPPortier · 2026-07-23T09:42:32Z

+      return;
+    }
+    console.log(`✅ Found ${response.data.length} Provisioning webhooks.`);
+    for (const webhook of response.data) {


It is an auto-paginated response right ?
Here the snippets will only log 1st page.
Better to use this form: https://github.com/sinch/sinch-sdk-node/blob/v1.6-next/examples/snippets/conversation/applications/list.js#L24-L26

JPPortier · 2026-07-23T09:43:44Z

+  // The URL called by Sinch when sending event
+  const webhookTarget = 'MY_WEBHOOK_URL';
+  // The secret to be used to validate event
+  const webhookSecret = 'MY_WEBHOOK_SECRET';


See comments about variables form

JPPortier · 2026-07-23T09:47:48Z

@@ -0,0 +1,2 @@
+## Version 1.5.0


Now target is 1.6

JPPortier · 2026-07-23T09:48:17Z

@@ -0,0 +1,40 @@
+{
+    "name": "@sinch/provisioning",
+    "version": "1.5.0",


JPPortier · 2026-07-23T09:48:30Z

+      "test:e2e": "cucumber-js"
+    },
+    "dependencies": {
+      "@sinch/sdk-client": "1.5.0"


… format options

…stname in tests

Hurus111 added 11 commits June 12, 2026 15:20

feat(provisioning): add initial version of Sinch Provisioning SDK wit…

85ab705

…h Webhooks API and related configurations

feat(provisioning): implement webhooks API with models and request ha…

8f53bb3

…ndling

test(provisioning): add comprehensive tests for Provisioning API and …

c06d761

…Webhooks API functionality

fix(provisioning): downgrade @sinch/sdk-client to version 1.4.2

7510bd3

refactor(provisioning): reorganize imports and remove unused Webhooks…

befe7cf

…Api export

feat(provisioning): add ProvisioningService to SinchClient and update…

49bddab

… package.json

feat(provisioning): add webhooks management snippets

85b26e1

feat(provisioning): add webhook configuration options to .env.example

d06b187

feat(provisioning): add additional webhooks management commands to pa…

45d7cd6

…ckage.json

feat(provisioning): add e2e test feature files for provisioning package

0c71ee8

feat(provisioning): add test configuration for provisioning package

21107be

Hurus111 requested review from JPPortier, asein-sinch, edu-sinch and matsk-sinch as code owners June 18, 2026 10:29

Hurus111 added 2 commits June 18, 2026 12:31

Merge branch 'v1.5-next' into DEVEXP-1391-Implement-PAPI-Webhooks

528de91

feat(workflow): include provisioning package in npm publish step

8aaf9ce

JPPortier reviewed Jun 22, 2026

View reviewed changes

Hurus111 changed the base branch from v1.5-next to v1.6-next July 22, 2026 14:44

Hurus111 requested a review from marcos-sinch as a code owner July 22, 2026 14:44

Hurus111 added 6 commits July 22, 2026 16:50

Merge branch 'v1.6-next' into DEVEXP-1391-Implement-PAPI-Webhooks

aaa5d56

refactor(snippets): use webhook hardcoded values and remove environme…

d47f869

…nt variable dependencies

fix(webhook-trigger): allow any string as a valid webhook trigger type

fd50c3c

fix(webhooks): clarify page size limit in ListWebhooksRequestData int…

1b54d6e

…erface

refactor(webhooks): update list method to return ApiListPromise and a…

152949b

…djust related tests

chore(provisioning): update @sinch/sdk-client dependency to version 1…

73c5336

….5.0

JPPortier reviewed Jul 23, 2026

View reviewed changes

Hurus111 added 3 commits July 23, 2026 16:50

chore(cucumber): update cucumber configuration to include ts-node and…

a7fbb6e

… format options

chore(provisioning): bump version to 1.6.0 and update provisioning ho…

40bc356

…stname in tests

fix(webhooks): update webhook URL and secret in provisioning examples

5c9e0a8

		const webhookTarget = process.env.WEBHOOK_TARGET ?? 'https://example.com/webhook';
		const webhookSecret = process.env.WEBHOOK_SECRET ?? 'MY_WEBHOOK_SECRET';

-  const webhookId = process.env.WEBHOOK_ID ?? 'WEBHOOK_ID';
+  // The ID of the Webhook to retrieve
+  const webhookId = 'WEBHOOK_ID';

	const webhookId = process.env.WEBHOOK_ID ?? 'WEBHOOK_ID';
	// The ID of the Webhook to delete
	const webhookId = 'WEBHOOK_ID';

Uh oh!

Conversation

Hurus111 commented Jun 18, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

JPPortier left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants