Back to endpoints

Create a new webhook for an organization

POST api/V3/{language}/org/{orgIdentifier}/webhooks

Allows you to create or update a webhook subscription. The model should contain name, url, context, version, action similar to the UI.

Request Information

URI Parameters

PARAMETERS
language (string)

Language in which the localizable values should be returned. Part of base url. Value is either 'fr' or 'en'

Required
orgIdentifier (string)

Amilia-specific organization identifier. This identifier can be either the organization number, such as 8008, or the organization URL identifier. You can find that by looking at the URL of your Amilia store. It may look like lower-case words separated by a dash, such as forest-explorers. Note that in v2 and v1 we call that the 'rewrite URL'.

Required

Body Parameters

PARAMETERS
Name (string)

No description available

Optional
Url (string)

No description available

Optional
Context (string)

No description available

Optional
Action (string)

No description available

Optional
Version (string)

No description available

Optional

Request Formats

CODE SAMPLE JSON
{
  "Name": "string 1",
  "Url": "string 2",
  "Context": "string 3",
  "Action": "string 4",
  "Version": "string 5"
}
CODE SAMPLE JSON

Sample not available because invalid.

Response Information

Resource Description

No description available