SuperOffice

Links

    SuperOffice API

    Getting access, Developing, Testing

    Back to SuperOffice

    Creates a new Webhook

    Calls the Webhook agent service SaveWebhook. ## Online Restricted: ## The Webhook agent is not available in Online by default. Access must be requested specifically when app is registered.

    Input

    type: object properties: parameters: type: object properties: newEntity: description: "Webhook definitions. Webhooks broadcast events from NetServer to remote servers.\r\n<para />\r\nCarrier object for Webhook.\r\nServices for the Webhook Carrier is available from the <see cref=\"T:SuperOffice.CRM.Services.IWebhookAgent\">Webhook Agent</see>." type: object properties: WebhookId: format: int32 description: Primary Key. Unique id for this webhook. type: integer Name: description: Name to identify this webhook. Does not have to be unique. type: string Events: description: >- Array of event names that trigger this webhook: ['contact.created', 'sale.changed'] type: array items: type: string TargetUrl: description: >- Destination to POST event info to. URL for webhooks. Id for CRM scripts type: string Secret: description: >- Shared secret key used for generating SHA256 HMAC signature, so that receiver can verify that call came from this server type: string State: description: >- Webhook status - should we post events to the URL? 1=Active, 2=Stopped or 3=TooManyErrors enum: - Unknown - Active - Stopped - TooManyErrors type: string Type: description: >- Name of plugin that handles this webhook. 'webhook' for webhooks, which are handled by the system plugin. type: string Headers: description: Custom HTTP Headers to add to webhook requests. type: object additionalProperties: type: string Properties: description: Custom values to inject into JSON body of webhook call. type: object additionalProperties: type: object Registered: format: date-time description: Registered when in UTC. type: string RegisteredAssociate: description: The user that created the webhook. type: object properties: AssociateId: format: int32 description: Primary key type: integer Name: description: Initials, also login name, possibly database user name type: string PersonId: format: int32 description: "Owning person record \r\n<para>Use MDO List name \"person\" to get list items.</para>" type: integer Rank: format: int32 description: Rank order type: integer Tooltip: description: Tooltip or other description type: string Type: description: >- User type - 1 = internal user, 2 = resource, 3 = external user, 4 = anonymous, 5 = system enum: - Unknown - InternalAssociate - ResourceAssociate - ExternalAssociate - AnonymousAssociate - SystemAssociate type: string GroupIdx: format: int32 description: >- Primary group membership, see UserGroupLink for secondary memberships type: integer FullName: description: >- The associate's culture formatted fullname (firstname, middleName and lastname) type: string FormalName: description: >- The associate's culture formatted formalname (firstname, middleName and lastname, title, mrmrs) type: string Deleted: description: >- If true, the user is retired and should have no rights, not appear in lists, etc. type: boolean EjUserId: format: int32 description: >- ID of the ej user record corresponding to this associate; 0 for associates that are not ej users type: integer UserName: description: User name type: string TableRight: type: object properties: Mask: enum: - None - Select - Update - Insert - Delete - Filtering - RestrictedUpdate - Unused1 - Uninitialized - FULL - WRITE - URU - UDR - UR - URI - R - RI - RF - F - FI type: string Reason: type: string FieldProperties: type: object additionalProperties: type: object properties: FieldRight: type: object properties: Mask: enum: - None - Read - Write - Update - Unused1 - Unused2 - Unused3 - Unused4 - Nullable - UIHintMandatory - UIHintReadOnly - FULL - UIHints type: string Reason: type: string FieldType: type: string FieldLength: format: int32 type: integer Updated: format: date-time description: Last updated when in UTC. type: string UpdatedAssociate: description: The user that last updated the webhook. type: object properties: AssociateId: format: int32 description: Primary key type: integer Name: description: Initials, also login name, possibly database user name type: string PersonId: format: int32 description: "Owning person record \r\n<para>Use MDO List name \"person\" to get list items.</para>" type: integer Rank: format: int32 description: Rank order type: integer Tooltip: description: Tooltip or other description type: string Type: description: >- User type - 1 = internal user, 2 = resource, 3 = external user, 4 = anonymous, 5 = system enum: - Unknown - InternalAssociate - ResourceAssociate - ExternalAssociate - AnonymousAssociate - SystemAssociate type: string GroupIdx: format: int32 description: >- Primary group membership, see UserGroupLink for secondary memberships type: integer FullName: description: >- The associate's culture formatted fullname (firstname, middleName and lastname) type: string FormalName: description: >- The associate's culture formatted formalname (firstname, middleName and lastname, title, mrmrs) type: string Deleted: description: >- If true, the user is retired and should have no rights, not appear in lists, etc. type: boolean EjUserId: format: int32 description: >- ID of the ej user record corresponding to this associate; 0 for associates that are not ej users type: integer UserName: description: User name type: string TableRight: type: object properties: Mask: enum: - None - Select - Update - Insert - Delete - Filtering - RestrictedUpdate - Unused1 - Uninitialized - FULL - WRITE - URU - UDR - UR - URI - R - RI - RF - F - FI type: string Reason: type: string FieldProperties: type: object additionalProperties: type: object properties: FieldRight: type: object properties: Mask: enum: - None - Read - Write - Update - Unused1 - Unused2 - Unused3 - Unused4 - Nullable - UIHintMandatory - UIHintReadOnly - FULL - UIHints type: string Reason: type: string FieldType: type: string FieldLength: format: int32 type: integer $select: type: string description: >- Optional comma separated list of properties to include in the result. Other fields are then nulled out to reduce payload size: "Name,department,category" Default = show all fields. Accept-Language: type: string description: >- Convert string references and multi-language values into a specified language (iso2) code. SO-Language: type: string description: >- Convert string references and multi-language values into a specified language (iso2) code. Overrides Accept-Language value. SO-Culture: type: string description: >- Number, date formatting in a specified culture (iso2 language) code. Partially overrides SO-Language/Accept-Language value. Ignored if no Language set. SO-TimeZone: type: string description: >- Specify the timezone code that you would like date/time responses converted to. SO-AppToken: type: string description: >- The application token that identifies the partner app. Used when calling Online WebAPI from a server. required: - newEntity title: Parameters