Webhook Management

Endpoints for configuring and managing webhooks

Retrieve webhook url

get

This endpoint allows partners to get the webhook url. Webhook url will be used to send important events when something changes on client, channel or waba account.

Retrieves the webhook URL configured for the partner.

This URL receives various asynchronous notifications from our system. See the main Webhooks section at the bottom of the page for a complete list of all possible events.

Key Events:

• A new channel is created: Channel Created

• A message template's status changes: Template Status Changed

• A channel's messaging is enabled: Template Messaging Enabled

⚠️ Disclaimer: The webhook definitions in the linked section above were not verified by a human, so please take it with a grain of salt.

Authorizations

PartnerApiKeyV2Bearer

X-API-KeystringRequired

API Key for V2 authentication. Send your Partner API key in the X-API-Key header. Preferred authentication method.

Path parameters

partner_idstringRequired

The ID of the partner.

Example: examplePA

Responses

200

Successful response

application/json

webhook_urlstring · urlOptional

Webhook url

Example: https://yourwebsite.com/webhook

400

Wrong payload

application/json

404

Not found

application/json

get

/api/v2/partners/{partner_id}/webhook_url

HTTPcURLJavaScriptPython

GET /api/v2/partners/{partner_id}/webhook_url HTTP/1.1
Host: hub.360dialog.io
X-API-Key: YOUR_API_KEY
Accept: */*

{
  "webhook_url": "https://yourwebsite.com/webhook"
}

Set/Update webhook url

post

This endpoint allows partners to set the partner webhook url. This endpoint is only for partner webhook settings, not for WABA or Channel webhooks.

Retrieves the webhook URL configured for the partner.

This URL receives various asynchronous notifications from our system. See the main Webhooks section at the bottom of the page for a complete list of all possible events.

Key Events:

• A new channel is created: Channel Created

• A message template's status changes: Template Status Changed

• A channel's messaging is enabled: Template Messaging Enabled

⚠️ Disclaimer: The webhook definitions in the linked section above were not verified by a human, so please take it with a grain of salt.

Authorizations

PartnerApiKeyV2Bearer

X-API-KeystringRequired

API Key for V2 authentication. Send your Partner API key in the X-API-Key header. Preferred authentication method.

Path parameters

partner_idstringRequired

The ID of the partner.

Example: examplePA

Body

application/json

webhook_urlstring · urlRequired

Webhook url

Example: https://yourwebsite.com/webhook

Responses

200

Successful response

application/json

idstringOptional

Partner ID

Example: examplePA

brand_namestringOptional

Brand name

Example: 360dialog

payment_requiredbooleanOptionalDeprecated

[Deprecated]

Example: true

logo_urlstring · nullableOptional

Logo url

Example: https://storage.com/logo.png

onboarding_deeplink_add_paramsbooleanOptionalDeprecated

[Internal Field]

webhook_urlstring · urlOptional

Webhook url for Partners API events (non-messaging)

Example: https://yourwebsite.com/webhook

partner_redirect_urlstring · urlOptional

Partner redirect URL, clients will be redirected to this URL after integrated onboarding is done.

Example: https://yourwebsite.com/redirect

countrystringOptional

Country code

Example: US

blocked_new_submissionbooleanOptionalDeprecated

[Internal Field]

allow_client_to_add_phone_nobooleanOptional

If set to false, clients will not be able to onboard new numbers

Example: true

settingsany ofOptional

Settings that configure features of the partner hub

or

object · nullableOptional

billing_systemstringOptionalDeprecated

[Internal Field]

publishable_keystring · nullableOptionalDeprecated

[Deprecated] Stripe public key

Default: null

400

Wrong payload

application/json

404

Not found

application/json

post

/api/v2/partners/{partner_id}/webhook_url

HTTPcURLJavaScriptPython

POST /api/v2/partners/{partner_id}/webhook_url HTTP/1.1
Host: hub.360dialog.io
X-API-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 49

{
  "webhook_url": "https://yourwebsite.com/webhook"
}

{
  "id": "examplePA",
  "brand_name": "360dialog",
  "logo_url": "https://storage.com/logo.png",
  "webhook_url": "https://yourwebsite.com/webhook",
  "partner_redirect_url": "https://yourwebsite.com/redirect",
  "country": "US",
  "allow_client_to_add_phone_no": true,
  "settings": {
    "partner_change_request": {
      "auto_approve": true
    },
    "account_sharing": {
      "solution_id": "1343564534452435",
      "business_manager_id": "24862834653473623",
      "solution_status": "ACTIVE"
    },
    "default_data_localization_region": "DE",
    "use_marketing_messages_api": true,
    "bearer_token_auth_disabled": false,
    "io_secure": {
      "io_secret": "9i3fKnYx...",
      "io_signature_verification_enabled": false
    }
  }
}

Retrieve webhook headers

get

This endpoint allows partners to get the webhook headers. Partners can set http headers that they want to receive in webhook requests. Example: Authorization, Content-Type.

Authorizations

PartnerApiKeyV2Bearer

X-API-KeystringRequired

API Key for V2 authentication. Send your Partner API key in the X-API-Key header. Preferred authentication method.

Path parameters

partner_idstringRequired

The ID of the partner.

Example: examplePA

Responses

200

Successful response

application/json

400

Wrong payload

application/json

404

Not found

application/json

get

/api/v2/partners/{partner_id}/webhook_headers

HTTPcURLJavaScriptPython

GET /api/v2/partners/{partner_id}/webhook_headers HTTP/1.1
Host: hub.360dialog.io
X-API-Key: YOUR_API_KEY
Accept: */*

{
  "webhook_headers": {
    "Authorization": "Bearer <KEY>"
  }
}

Set/Update webhook headers

post

This endpoint allows partners to set the webhook headers. Partners can set http headers that they want to receive in webhook requests. Example: Authorization, Content-Type, ...

Authorizations

PartnerApiKeyV2Bearer

X-API-KeystringRequired

API Key for V2 authentication. Send your Partner API key in the X-API-Key header. Preferred authentication method.

Path parameters

partner_idstringRequired

The ID of the partner.

Example: examplePA

Body

application/json

Responses

200

Successful response

application/json

idstringOptional

Partner ID

Example: examplePA

brand_namestringOptional

Brand name

Example: 360dialog

payment_requiredbooleanOptionalDeprecated

[Deprecated]

Example: true

logo_urlstring · nullableOptional

Logo url

Example: https://storage.com/logo.png

onboarding_deeplink_add_paramsbooleanOptionalDeprecated

[Internal Field]

webhook_urlstring · urlOptional

Webhook url for Partners API events (non-messaging)

Example: https://yourwebsite.com/webhook

partner_redirect_urlstring · urlOptional

Partner redirect URL, clients will be redirected to this URL after integrated onboarding is done.

Example: https://yourwebsite.com/redirect

countrystringOptional

Country code

Example: US

blocked_new_submissionbooleanOptionalDeprecated

[Internal Field]

allow_client_to_add_phone_nobooleanOptional

If set to false, clients will not be able to onboard new numbers

Example: true

settingsany ofOptional

Settings that configure features of the partner hub

or

object · nullableOptional

billing_systemstringOptionalDeprecated

[Internal Field]

publishable_keystring · nullableOptionalDeprecated

[Deprecated] Stripe public key

Default: null

400

Wrong payload

application/json

404

Not found

application/json

post

/api/v2/partners/{partner_id}/webhook_headers

HTTPcURLJavaScriptPython

POST /api/v2/partners/{partner_id}/webhook_headers HTTP/1.1
Host: hub.360dialog.io
X-API-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 78

{
  "webhook_headers": {
    "Authorization": "Bearer <KEY>",
    "X-Requestor": "360dialog"
  }
}

{
  "id": "examplePA",
  "brand_name": "360dialog",
  "logo_url": "https://storage.com/logo.png",
  "webhook_url": "https://yourwebsite.com/webhook",
  "partner_redirect_url": "https://yourwebsite.com/redirect",
  "country": "US",
  "allow_client_to_add_phone_no": true,
  "settings": {
    "partner_change_request": {
      "auto_approve": true
    },
    "account_sharing": {
      "solution_id": "1343564534452435",
      "business_manager_id": "24862834653473623",
      "solution_status": "ACTIVE"
    },
    "default_data_localization_region": "DE",
    "use_marketing_messages_api": true,
    "bearer_token_auth_disabled": false,
    "io_secure": {
      "io_secret": "9i3fKnYx...",
      "io_signature_verification_enabled": false
    }
  },
  "webhook_headers": {
    "Authorization": "Bearer <KEY>"
  }
}