Version: React Native SDK

Hooks

Set hooks

You can define custom hooks to be executed on various events.

Thanks to this you will be able to interact with your application when a survey appears, or execute some custom code when a survey is submitted.

You can define hooks on initSdk() and startSurvey() commands. Hooks are all optional.

Available hooks

Hook Name	Available on `initSdk()`	Available on `startSurvey()`
`onSurveyShowed`	Yes ✅	Yes ✅
`onMessageShowed`	Yes ✅	Yes ✅
`onSurveyStarted`	Yes ✅	Yes ✅
`onMessageStarted`	Yes ✅	Yes ✅
`onQuestionReplied`	Yes ✅	Yes ✅
`onSurveyCompleted`	Yes ✅	Yes ✅
`onMessageCompleted`	Yes ✅	Yes ✅
`onSurveyHidden`	Yes ✅	Yes ✅
`onMessageHidden`	Yes ✅	Yes ✅
`onAppStoreRatingTriggered`	Yes ✅	Yes ✅
`onReady`	Yes ✅	No ❌
`onSurveyDisplayAllowed`	Yes ✅	No ❌
`onMessageDisplayAllowed`	Yes ✅	No ❌

Set hooks on SDK init

initSdk(
  "<channel-id>",
  "<user-id>",
  {
    isConnected: false,
    age: 29,
    product: "iPhone 13",
    email: "e2e@screeb.app",
  },
  {
    version: "1.0.0",
    onReady: (payload: any) => {
      console.log("onReady", payload);
    },
    onSurveyDisplayAllowed: (payload: any) => {
      console.log("onSurveyDisplayAllowed", payload);
      // return false to prevent display
      return true;
    },
  }
);

Set hooks on survey start

startSurvey(
  "<survey-id>",
  true,           // allowMultipleResponses
  {},             // hiddenFields
  true,           // ignoreSurveyStatus
  {
    version: "1.0.0",
    onSurveyShowed: (payload: any) => {
      console.log("onSurveyShowed", payload);
    },
  }
);

`onSurveyShowed`

Called when a survey is showed.

Example

initSdk(
  "<channel-id>",
  "<user-id>",
  {...},
  {
    version: "1.0.0",
    onSurveyShowed: (payload: any) => {
      console.log("onSurveyShowed", payload);
    },
  }
);

Payload definition

{
    channel: {
        id: string,
        type: "ios"
    },
    survey: {
        id: string,
        survey_position: "center-left" | "center-center" | "center-right" | "bottom-left" | "bottom-center" | "bottom-right",
        survey_size: 25 | 50 | 75 | 100 | 125 | 150,
        survey_format: "conversational" | "cards",
    },
    response: {
        id: string,
        items: {
            question: {
                id: string;
                title: string;
                type: "text" | "video";
                url: string;
            };
            answer: {
                fields: {
                    type: "string" | "number" | "boolean" | "none" | "time" | "url";
                },
                text: string;
                number: number;
                boolean: boolean;
                time: Date;
                url: string;
            }[] | undefined;
            replied_at: Date | undefined;
        }[];
    },
    user: {
        anonymous_id: string,
        user_id: string,
    }
}

`onSurveyStarted`

Called when a survey is started.

Example

initSdk(
  "<channel-id>",
  "<user-id>",
  {...},
  {
    version: "1.0.0",
    onSurveyStarted: (payload: any) => {
      console.log("onSurveyStarted", payload);
    },
  }
);

Payload definition

{
    channel: {
        id: string,
        type: "ios"
    },
    survey: {
        id: string,
        survey_position: "center-left" | "center-center" | "center-right" | "bottom-left" | "bottom-center" | "bottom-right",
        survey_size: 25 | 50 | 75 | 100 | 125 | 150,
        survey_format: "conversational" | "cards",
    },
    response: {
        id: string,
    },
    user: {
        anonymous_id: string,
        user_id: string,
    }
}

`onQuestionReplied`

Called when a question is replied.

Example

initSdk(
  "<channel-id>",
  "<user-id>",
  {...},
  {
    version: "1.0.0",
    onQuestionReplied: (payload: any) => {
      console.log("onQuestionReplied", payload);
    },
  }
);

Payload definition

{
    channel: {
        id: string,
        type: "ios"
    },
    survey: {
        id: string,
        survey_position: "center-left" | "center-center" | "center-right" | "bottom-left" | "bottom-center" | "bottom-right",
        survey_size: 25 | 50 | 75 | 100 | 125 | 150,
        survey_format: "conversational" | "cards",
    },
    response: {
        id: string,
        status: "started" | "ended" | "closed" | "interrupted"
        question: {
            id: string;
            title: string;
            type: "text" | "video";
            url: string;
        };
        answer: {
            fields: {
                type: "string" | "number" | "boolean" | "none" | "time" | "url";
            },
            text: string;
            number: number;
            boolean: boolean;
            time: Date;
            url: string;
        };
        items: {
            question: {
                id: string;
                title: string;
                type: "text" | "video";
                url: string;
            };
            answer: {
                fields: {
                    type: "string" | "number" | "boolean" | "none" | "time" | "url";
                },
                text: string;
                number: number;
                boolean: boolean;
                time: Date;
                url: string;
            }[] | undefined;
            replied_at: Date | undefined;
        }[];
    },
    user: {
        anonymous_id: string,
        user_id: string,
    }
}

`onSurveyCompleted`

Called when a survey is completed.

Example

initSdk(
  "<channel-id>",
  "<user-id>",
  {...},
  {
    version: "1.0.0",
    onSurveyCompleted: (payload: any) => {
      console.log("onSurveyCompleted", payload);
    },
  }
);

Payload definition

{
    channel: {
        id: string,
        type: "ios"
    },
    survey: {
        id: string,
        survey_position: "center-left" | "center-center" | "center-right" | "bottom-left" | "bottom-center" | "bottom-right",
        survey_size: 25 | 50 | 75 | 100 | 125 | 150,
        survey_format: "conversational" | "cards",
    },
    response: {
        id: string,
        items: {
            question: {
                id: string;
                title: string;
                type: "text" | "video";
                url: string;
            };
            answer: {
                fields: {
                    type: "string" | "number" | "boolean" | "none" | "time" | "url";
                },
                text: string;
                number: number;
                boolean: boolean;
                time: Date;
                url: string;
            }[] | undefined;
            replied_at: Date | undefined;
        }[];
    },
    user: {
        anonymous_id: string,
        user_id: string,
    }
}

`onSurveyHidden`

Called when a survey is hidden.

Example

initSdk(
  "<channel-id>",
  "<user-id>",
  {...},
  {
    version: "1.0.0",
    onSurveyHidden: (payload: any) => {
      console.log("onSurveyHidden", payload);
    },
  }
);

Payload definition

{
    channel: {
        id: string,
        type: "ios"
    },
    survey: {
        id: string,
        survey_position: "center-left" | "center-center" | "center-right" | "bottom-left" | "bottom-center" | "bottom-right",
        survey_size: 25 | 50 | 75 | 100 | 125 | 150,
        survey_format: "conversational" | "cards",
    },
    response: {
        id: string,
        hide_reason: "started" | "ended" | "closed" | "interrupted",
        items: {
            question: {
                id: string;
                title: string;
                type: "text" | "video";
                url: string;
            };
            answer: {
                fields: {
                    type: "string" | "number" | "boolean" | "none" | "time" | "url";
                },
                text: string;
                number: number;
                boolean: boolean;
                time: Date;
                url: string;
            }[] | undefined;
            replied_at: Date | undefined;
        }[];
    },
    user: {
        anonymous_id: string,
        user_id: string,
    }
}

`onAppStoreRatingTriggered`

Called when an App Store Rating question is triggered.

Example

initSdk(
  "<channel-id>",
  "<user-id>",
  {...},
  {
    version: "1.0.0",
    onAppStoreRatingTriggered: (payload: any) => {
      console.log("onAppStoreRatingTriggered", payload);
    },
  }
);

Payload definition

{
    channel: {
        id: string,
        type: "ios"
    },
    user: {
        anonymous_id: string,
        user_id: string,
    }
}

`onReady`

Called when the SDK is ready. Only available on initSdk().

Example

initSdk(
  "<channel-id>",
  "<user-id>",
  {...},
  {
    version: "1.0.0",
    onReady: (payload: any) => {
      console.log("onReady", payload);
    },
  }
);

Payload definition

{
    channel: {
        id: string,
        type: "ios"
    },
    user: {
        anonymous_id: string,
        user_id: string,
    }
}

`onSurveyDisplayAllowed`

Called before a survey display to allow it or not. Only available on initSdk(). Return a boolean value. Return false to prevent display.

Example

initSdk(
  "<channel-id>",
  "<user-id>",
  {...},
  {
    version: "1.0.0",
    onSurveyDisplayAllowed: (payload: any) => {
      console.log("onSurveyDisplayAllowed", payload);
      // return false to prevent display
      return true;
    },
  }
);

Payload definition

{
    channel: {
        id: string,
        type: "ios"
    },
    survey: {
        id: string,
    },
    user: {
        anonymous_id: string,
        user_id: string,
    }
}

`onMessageShowed`

Called when a message is showed.

Example

initSdk(
  "<channel-id>",
  "<user-id>",
  {...},
  {
    version: "1.0.0",
    onMessageShowed: (payload: any) => {
      console.log("onMessageShowed", payload);
    },
  }
);

Payload definition

{
    channel: {
        id: string,
        type: "ios"
    },
    message: {
        message_size: 25 | 50 | 75 | 100 | 125 | 150,
        id: string | null,
    },
    response: {
        id: string,
        items: {
            question: {
                id: string;
                title: string;
                type: "text" | "video";
                url: string;
            };
            answer: {
                fields: {
                    type: "string" | "number" | "boolean" | "none" | "time" | "url";
                },
                text: string;
                number: number;
                boolean: boolean;
                time: Date;
                url: string;
            }[] | undefined;
            replied_at: Date | undefined;
        }[];
    },
    user: {
        anonymous_id: string,
        user_id: string,
    }
}

`onMessageStarted`

Called when a message is started.

Example

initSdk(
  "<channel-id>",
  "<user-id>",
  {...},
  {
    version: "1.0.0",
    onMessageStarted: (payload: any) => {
      console.log("onMessageStarted", payload);
    },
  }
);

Payload definition

{
    channel: {
        id: string,
        type: "ios"
    },
    message: {
        message_size: 25 | 50 | 75 | 100 | 125 | 150,
        id: string | null,
    },
    response: {
        id: string,
    },
    user: {
        anonymous_id: string,
        user_id: string,
    }
}

`onMessageCompleted`

Called when a message is completed.

Example

initSdk(
  "<channel-id>",
  "<user-id>",
  {...},
  {
    version: "1.0.0",
    onMessageCompleted: (payload: any) => {
      console.log("onMessageCompleted", payload);
    },
  }
);

Payload definition

{
    channel: {
        id: string,
        type: "ios"
    },
    message: {
        message_size: 25 | 50 | 75 | 100 | 125 | 150,
        id: string | null,
    },
    response: {
        id: string,
        items: {
            question: {
                id: string;
                title: string;
                type: "text" | "video";
                url: string;
            };
            answer: {
                fields: {
                    type: "string" | "number" | "boolean" | "none" | "time" | "url";
                },
                text: string;
                number: number;
                boolean: boolean;
                time: Date;
                url: string;
            }[] | undefined;
            replied_at: Date | undefined;
        }[];
    },
    user: {
        anonymous_id: string,
        user_id: string,
    }
}

`onMessageHidden`

Called when a message is hidden.

Example

initSdk(
  "<channel-id>",
  "<user-id>",
  {...},
  {
    version: "1.0.0",
    onMessageHidden: (payload: any) => {
      console.log("onMessageHidden", payload);
    },
  }
);

Payload definition

{
    channel: {
        id: string,
        type: "ios"
    },
    message: {
        message_size: 25 | 50 | 75 | 100 | 125 | 150,
        id: string | null,
    },
    response: {
        id: string,
        hide_reason: "started" | "ended" | "closed" | "interrupted",
        items: {
            question: {
                id: string;
                title: string;
                type: "text" | "video";
                url: string;
            };
            answer: {
                fields: {
                    type: "string" | "number" | "boolean" | "none" | "time" | "url";
                },
                text: string;
                number: number;
                boolean: boolean;
                time: Date;
                url: string;
            }[] | undefined;
            replied_at: Date | undefined;
        }[];
    },
    user: {
        anonymous_id: string,
        user_id: string,
    }
}

`onMessageDisplayAllowed`

Called before a message display to allow it or not. Only available on initSdk(). Return a boolean value. Return false to prevent display.

Example

initSdk(
  "<channel-id>",
  "<user-id>",
  {...},
  {
    version: "1.0.0",
    onMessageDisplayAllowed: (payload: any) => {
      console.log("onMessageDisplayAllowed", payload);
      // return false to prevent display
      return true;
    },
  }
);

Payload definition

{
    channel: {
        id: string,
        type: "ios"
    },
    message: {
        id: string,
    },
    user: {
        anonymous_id: string,
        user_id: string,
    }
}

Set hooks​

Available hooks​

Set hooks on SDK init​

Set hooks on survey start​

onSurveyShowed​

onSurveyStarted​

onQuestionReplied​

onSurveyCompleted​

onSurveyHidden​

onAppStoreRatingTriggered​

onReady​

onSurveyDisplayAllowed​

onMessageShowed​

onMessageStarted​

onMessageCompleted​

onMessageHidden​

onMessageDisplayAllowed​

Set hooks

Available hooks

Set hooks on SDK init

Set hooks on survey start

`onSurveyShowed`

`onSurveyStarted`

`onQuestionReplied`

`onSurveyCompleted`

`onSurveyHidden`

`onAppStoreRatingTriggered`

`onReady`

`onSurveyDisplayAllowed`

`onMessageShowed`

`onMessageStarted`

`onMessageCompleted`

`onMessageHidden`

`onMessageDisplayAllowed`