Everyware DocsAPI Base URL
All documentation

Webhook Management

Note: At this moment, Everyware's webhooks support only Basic Auth when pushing data to the endpoints registered.

Access Endpoint URL https://rest.everyware.com/api/webhookManagement/retrieve-webhook-configurations [POST]

The Retrieve Webhook Configurations endpoint allows the caller to retrieve information about all of the

Inbound Request Parameters

Name Data Type Description Required/Optional
SalesSiteIDs Array<long> The list of the sales site IDs for which you want to retrieve webhook configurations. If you want to pull all webhook configurations for the master site and child sites, pass a null value explicitly. Optional

Code Sample

{
	"SalesSiteIDs": [444333, 333444]
}

{
	"IsSuccess": true,
    "Message": "Webhook information was retrieved successfully.",
    "Data": {
        "SalesSiteWebhookInformation": [
            {
                "SalesSiteID": 444333,
                "WebhookID": 1,
                "WebhookConfigurationID": 54543,
                "URL": "https://testurl.com/payment",
                "Active": true,
                "APILogin": null,
                "APIKey": null,
                "PaymentWebhookUsername": null,
                "PaymentWebhookPassword": null,
                "OnboardingWebhookUsername": null,
                "OnboardingWebhookPassword": null
            },
            {
                "SalesSiteID": 333444,
                "WebhookID": 22,
                "WebhookConfigurationID": 32323,
                "URL": "https://test2url.com/onboarding",
                "Active": true,
                "APILogin": null,
                "APIKey": null,
                "PaymentWebhookUsername": null,
                "PaymentWebhookPassword": null,
                "OnboardingWebhookUsername": null,
                "OnboardingWebhookPassword": null
            }
}

Add Webhook

Access Endpoint URL https://rest.everyware.com/api/webhookManagement/add-webhook [POST]

The Add Webhook endpoint allows the caller to register a URL that will receive a data push from Everyware's system after a payment or onboarding event occurs.

Inbound Request Parameters

Name Data Type Description Required/Optional
WebhookID long Indicates the type of event that will trigger the data push to the provided URL. 
    * 1 = Payment Webhook
    * 22 = Onboarding Webhook
  </td><td>
    Required
  </td></tr><tr><td>
    SalesSiteID
  </td><td>
    long (nullable)
  </td><td>
    The Sales Site in Everyware's system for which the provided URL should be used. If no Sales Site ID is provided in the request, the system will default to the ID associated with the credentials used to call the endpoint.
  </td><td>
    Optional
  </td></tr><tr><td>
    URL
  </td><td>
    string
  </td><td>
    The URL of the endpoint receiving the data push from Everyware. Please include the http prefix.
  </td><td>
    Required
  </td></tr><tr><td>
    PaymentWebhookUsername
  </td><td>
    string
  </td><td>
    The Basic Auth username that should be used in conjunction with the payment webhook.
  </td><td>
    Optional
  </td></tr><tr><td>
    PaymentWebhookPassword
  </td><td>
    string
  </td><td>
    The Basic Auth password that should be used in conjunction with the payment webhook.
  </td><td>
    Optional
  </td></tr><tr><td>
    OnboardingWebhookUsername
  </td><td>
    string
  </td><td>
    The Basic Auth username that should be used in conjunction with the onboarding webhook.
  </td><td>
    Optional
  </td></tr><tr><td>
    OnboardingWebhookPassword
  </td><td>
    string
  </td><td>
    The Basic Auth password that should be used in conjunction with the onboarding webhook.
  </td><td>
    Optional
  </td></tr></tbody></table>

Sample Code

{
	"WebhookID": "22",
  "SalesSiteID": null,
  "URL": "https://rest.everyware.com/accept-webhook-push",
  "PaymentWebhookUsername": "",
  "PaymentWebhookPassword": "",
  "OnboardingWebhookUsername": "3434324",
  "OnboardingWebhookPassword"| "ZECNTIR34234SERC"
}

{
	"IsSuccess": true,
  "Message": "The webhook has been configured successfully.",
  "Data": {
  	"WebhookConfigurationID": "3243245",
    "ErrorMessage": null
  }
}

{
	"IsSuccess": false,
  "Message": "Webhook configuration failed.",
  "Data": {
  	"WebhookConfigurationID": null
  }
}

Edit Webhook

Access Endpoint URL https://rest.everyware.com/api/webhookManagement/edit-webhook [PATCH]

Send a request to the endpoint above to edit the webhook configuration for a particular endpoint stored in Everyware's system.

Inbound Request Parameters

Name Data Type Description Required/Optional
WebhookConfigurationID long The ID associated with the configuration settings for a specific webhook in Everyware's system. Returned in the response from the Add Webhook endpoint. Required
WebhookID long Indicates the type of event that will trigger the data push to the provided URL. 
    * 1 = Payment Webhook
    * 22 = Onboarding Webhook
  </td><td>
    Required
  </td></tr><tr><td>
    SalesSiteID
  </td><td>
    long
  </td><td>
    The Sales Site in Everyware's system for which the provided URL should be used. If no Sales Site ID is provided in the request, the system will default to the ID associated with the credentials used to call the endpoint.
  </td><td>
    Optional
  </td></tr><tr><td>
    URL
  </td><td>
    string
  </td><td>
    The URL of the endpoint receiving the data push from Everyware. Please include the http prefix.
  </td><td>
    Required
  </td></tr><tr><td>
    Active
  </td><td>
    bool
  </td><td>
    Indicates whether the URL provided in the request body should receive a data push from Everyware's system when the specific event occurs.
  </td><td>
    Required
  </td></tr><tr><td>
    PaymentWebhookUsername
  </td><td>
    string
  </td><td>
    The Basic Auth username that should be used in conjunction with the payment webhook.
  </td><td>
    Optional
  </td></tr><tr><td>
    PaymentWebhookPassword
  </td><td>
    string
  </td><td>
    The Basic Auth password that should be used in conjunction with the payment webhook.
  </td><td>
    Optional
  </td></tr><tr><td>
    OnboardingWebhookUsername
  </td><td>
    string
  </td><td>
    The Basic Auth username that should be used in conjunction with the onboarding webhook.
  </td><td>
    Optional
  </td></tr><tr><td>
    OnboardingWebhookPassword
  </td><td>
    string
  </td><td>
    The Basic Auth password that should be used in conjunction with the onboarding webhook.
  </td><td>
    Optional
  </td></tr></tbody></table>

Sample Code

{
  "WebhookConfigurationID": "3243245",
	"WebhookID": "22",
  "SalesSiteID": null,
  "URL": "https://rest.everyware.com/accept-webhook-push",
  "Active": false,
  "PaymentWebhookUsername": "",
  "PaymentWebhookPassword": "",
  "OnboardingWebhookUsername": "3434324",
  "OnboardingWebhookPassword"| "ZECNTIR34234SERC"
}

{
	"IsSuccess": true,
  "Message": "Webhook configuration has been edited successfully."
}

{
	"IsSuccess": false,
  "Message": "Webhook configuration failed."
}

Remove Webhook Auth Credentials

Send a request to this endpoint to remove the Basic Auth credentials associated with a particular webhook for a specific sales site.

Inbound Request Parameters

Name Data Type Description Optional/Required
SalesSiteID nullable long The sales site ID for which you would like to delete a certain set of credentials. If null is passed through, the ID of the sales site making the call will be used by default. Optional
WebhookConfigurationID long The ID associated with the configuration settings for a specific webhook in Everyware's system. Returned in the response from the Add Webhook endpoint. Required
DeletePaymentWebhookCredentials bool Indicates whether the Basic Auth credentials for the Payment Webhook should be deleted. 
    Defaults to false.
  </td><td>
    Optional
  </td></tr><tr><td>
    DeleteOnboardingWebhookCredentials
  </td><td>
    bool
  </td><td>
    Indicates whether the Basic Auth credentials for the Onboarding Webhook should be deleted.  

    Defaults to false.
  </td><td>
    Optional
  </td></tr></tbody></table>